windows/mkwinsyscall: account for non-"err" return values when processing "?"
The "?" code assumed that the error value was always called "err", when
in reality it might be called something different (like "ret") or even
entirely absent. This commit makes the templating robust to that. At the
same time, we move a lot of the complexity out of the actual templates
and into helper functions, so that this remains easy to read.
Change-Id: I939d56413a24f0e3e1bbf13da5adf13e9401747a
Reviewed-on: https://go-review.googlesource.com/c/sys/+/275472
Trust: Jason A. Donenfeld <Jason@zx2c4.com>
Trust: Alex Brainman <alex.brainman@gmail.com>
Run-TryBot: Jason A. Donenfeld <Jason@zx2c4.com>
TryBot-Result: Go Bot <gobot@golang.org>
Reviewed-by: Alex Brainman <alex.brainman@gmail.com>
Jason A. Donenfeld
3 years ago
| 238 | 238 | |
| 239 | 239 | // Rets describes function return parameters. |
| 240 | 240 | type Rets struct { |
| 241 | Name string | |
| 242 | Type string | |
| 243 | ReturnsError bool | |
| 244 | FailCond string | |
| 241 | Name string | |
| 242 | Type string | |
| 243 | ReturnsError bool | |
| 244 | FailCond string | |
| 245 | fnMaybeAbsent bool | |
| 245 | 246 | } |
| 246 | 247 | |
| 247 | 248 | // ErrorVarName returns error variable name for r. |
| 272 | 273 | s := join(r.ToParams(), func(p *Param) string { return p.Name + " " + p.Type }, ", ") |
| 273 | 274 | if len(s) > 0 { |
| 274 | 275 | s = "(" + s + ")" |
| 276 | } else if r.fnMaybeAbsent { | |
| 277 | s = "(err error)" | |
| 275 | 278 | } |
| 276 | 279 | return s |
| 277 | 280 | } |
| 344 | 347 | Params []*Param |
| 345 | 348 | Rets *Rets |
| 346 | 349 | PrintTrace bool |
| 347 | MaybeAbsent bool | |
| 348 | 350 | dllname string |
| 349 | 351 | dllfuncname string |
| 350 | 352 | src string |
| 474 | 476 | } |
| 475 | 477 | if n := f.dllfuncname; strings.HasSuffix(n, "?") { |
| 476 | 478 | f.dllfuncname = n[:len(n)-1] |
| 477 | f.MaybeAbsent = true | |
| 479 | f.Rets.fnMaybeAbsent = true | |
| 478 | 480 | } |
| 479 | 481 | return f, nil |
| 480 | 482 | } |
| 574 | 576 | return strings.Join(a, ", ") |
| 575 | 577 | } |
| 576 | 578 | |
| 579 | // MaybeAbsent returns source code for handling functions that are possibly unavailable. | |
| 580 | func (p *Fn) MaybeAbsent() string { | |
| 581 | if !p.Rets.fnMaybeAbsent { | |
| 582 | return "" | |
| 583 | } | |
| 584 | const code = `%[1]s = proc%[2]s.Find() | |
| 585 | if %[1]s != nil { | |
| 586 | return | |
| 587 | }` | |
| 588 | errorVar := p.Rets.ErrorVarName() | |
| 589 | if errorVar == "" { | |
| 590 | errorVar = "err" | |
| 591 | } | |
| 592 | return fmt.Sprintf(code, errorVar, p.DLLFuncName()) | |
| 593 | } | |
| 594 | ||
| 577 | 595 | // IsUTF16 is true, if f is W (utf16) function. It is false |
| 578 | 596 | // for all A (ascii) functions. |
| 579 | 597 | func (f *Fn) IsUTF16() bool { |
| 914 | 932 | {{define "helpertmpvars"}}{{range .Params}}{{if .TmpVarHelperCode}} {{.TmpVarHelperCode}} |
| 915 | 933 | {{end}}{{end}}{{end}} |
| 916 | 934 | |
| 917 | {{define "maybeabsent"}}{{if .MaybeAbsent}}err = proc{{.DLLFuncName}}.Find() | |
| 918 | if err != nil { return } | |
| 935 | {{define "maybeabsent"}}{{if .MaybeAbsent}}{{.MaybeAbsent}} | |
| 919 | 936 | {{end}}{{end}} |
| 920 | 937 | |
| 921 | 938 | {{define "tmpvars"}}{{range .Params}}{{if .TmpVarCode}} {{.TmpVarCode}} |