pragmas.nim 45 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205
  1. #
  2. #
  3. # The Nim Compiler
  4. # (c) Copyright 2015 Andreas Rumpf
  5. #
  6. # See the file "copying.txt", included in this
  7. # distribution, for details about the copyright.
  8. #
  9. # This module implements semantic checking for pragmas
  10. import
  11. os, platform, condsyms, ast, astalgo, idents, semdata, msgs, renderer,
  12. wordrecg, ropes, options, strutils, extccomp, math, magicsys, trees,
  13. types, lookups, lineinfos, pathutils, linter
  14. const
  15. FirstCallConv* = wNimcall
  16. LastCallConv* = wNoconv
  17. const
  18. declPragmas = {wImportc, wImportObjC, wImportCpp, wImportJs, wExportc, wExportCpp,
  19. wExportNims, wExtern, wDeprecated, wNodecl, wError, wUsed}
  20. ## common pragmas for declarations, to a good approximation
  21. procPragmas* = declPragmas + {FirstCallConv..LastCallConv,
  22. wMagic, wNoSideEffect, wSideEffect, wNoreturn, wDynlib, wHeader,
  23. wCompilerProc, wNonReloadable, wCore, wProcVar, wVarargs, wCompileTime, wMerge,
  24. wBorrow, wImportCompilerProc, wThread,
  25. wAsmNoStackFrame, wDiscardable, wNoInit, wCodegenDecl,
  26. wGensym, wInject, wRaises, wTags, wLocks, wDelegator, wGcSafe,
  27. wConstructor, wLiftLocals, wStackTrace, wLineTrace, wNoDestroy}
  28. converterPragmas* = procPragmas - {wNoDestroy}
  29. methodPragmas* = procPragmas+{wBase}-{wImportCpp, wNoDestroy}
  30. templatePragmas* = {wDeprecated, wError, wGensym, wInject, wDirty,
  31. wDelegator, wExportNims, wUsed, wPragma}
  32. macroPragmas* = declPragmas + {FirstCallConv..LastCallConv,
  33. wMagic, wNoSideEffect, wCompilerProc, wNonReloadable, wCore,
  34. wDiscardable, wGensym, wInject, wDelegator}
  35. iteratorPragmas* = declPragmas + {FirstCallConv..LastCallConv, wNoSideEffect, wSideEffect,
  36. wMagic, wBorrow,
  37. wDiscardable, wGensym, wInject, wRaises,
  38. wTags, wLocks, wGcSafe}
  39. exprPragmas* = {wLine, wLocks, wNoRewrite, wGcSafe, wNoSideEffect}
  40. stmtPragmas* = {wChecks, wObjChecks, wFieldChecks, wRangeChecks,
  41. wBoundChecks, wOverflowChecks, wNilChecks, wStyleChecks, wAssertions,
  42. wWarnings, wHints,
  43. wLineDir, wStackTrace, wLineTrace, wOptimization, wHint, wWarning, wError,
  44. wFatal, wDefine, wUndef, wCompile, wLink, wLinksys, wPure, wPush, wPop,
  45. wPassl, wPassc,
  46. wDeadCodeElimUnused, # deprecated, always on
  47. wDeprecated,
  48. wFloatChecks, wInfChecks, wNanChecks, wPragma, wEmit, wUnroll,
  49. wLinearScanEnd, wPatterns, wTrMacros, wEffects, wNoForward, wReorder, wComputedGoto,
  50. wInjectStmt, wExperimental, wThis, wUsed}
  51. lambdaPragmas* = {FirstCallConv..LastCallConv,
  52. wNoSideEffect, wSideEffect, wNoreturn, wDynlib, wHeader,
  53. wThread, wAsmNoStackFrame,
  54. wRaises, wLocks, wTags, wGcSafe, wCodegenDecl, wNoInit}
  55. typePragmas* = declPragmas + {wMagic, wAcyclic,
  56. wPure, wHeader, wCompilerProc, wCore, wFinal, wSize, wShallow,
  57. wIncompleteStruct, wByCopy, wByRef,
  58. wInheritable, wGensym, wInject, wRequiresInit, wUnchecked, wUnion, wPacked,
  59. wBorrow, wGcSafe, wPartial, wExplain, wPackage}
  60. fieldPragmas* = declPragmas + {
  61. wGuard, wBitsize, wAlign} - {wExportNims, wNodecl} # why exclude these?
  62. varPragmas* = declPragmas + {wVolatile, wRegister, wThreadVar,
  63. wMagic, wHeader, wCompilerProc, wCore, wDynlib,
  64. wNoInit, wCompileTime, wGlobal,
  65. wGensym, wInject, wCodegenDecl, wGuard, wGoto}
  66. constPragmas* = declPragmas + {wHeader, wMagic,
  67. wGensym, wInject,
  68. wIntDefine, wStrDefine, wBoolDefine, wCompilerProc, wCore}
  69. letPragmas* = varPragmas
  70. procTypePragmas* = {FirstCallConv..LastCallConv, wVarargs, wNoSideEffect,
  71. wThread, wRaises, wLocks, wTags, wGcSafe}
  72. forVarPragmas* = {wInject, wGensym}
  73. allRoutinePragmas* = methodPragmas + iteratorPragmas + lambdaPragmas
  74. enumFieldPragmas* = {wDeprecated}
  75. proc getPragmaVal*(procAst: PNode; name: TSpecialWord): PNode =
  76. let p = procAst[pragmasPos]
  77. if p.kind == nkEmpty: return nil
  78. for it in p:
  79. if it.kind in nkPragmaCallKinds and it.len == 2 and it[0].kind == nkIdent and
  80. it[0].ident.id == ord(name):
  81. return it[1]
  82. proc pragma*(c: PContext, sym: PSym, n: PNode, validPragmas: TSpecialWords;
  83. isStatement: bool = false)
  84. proc recordPragma(c: PContext; n: PNode; key, val: string; val2 = "") =
  85. var recorded = newNodeI(nkCommentStmt, n.info)
  86. recorded.add newStrNode(key, n.info)
  87. recorded.add newStrNode(val, n.info)
  88. if val2.len > 0: recorded.add newStrNode(val2, n.info)
  89. c.graph.recordStmt(c.graph, c.module, recorded)
  90. const
  91. errStringLiteralExpected = "string literal expected"
  92. errIntLiteralExpected = "integer literal expected"
  93. proc invalidPragma*(c: PContext; n: PNode) =
  94. localError(c.config, n.info, "invalid pragma: " & renderTree(n, {renderNoComments}))
  95. proc illegalCustomPragma*(c: PContext, n: PNode, s: PSym) =
  96. localError(c.config, n.info, "cannot attach a custom pragma to '" & s.name.s & "'")
  97. proc pragmaAsm*(c: PContext, n: PNode): char =
  98. result = '\0'
  99. if n != nil:
  100. for i in 0 ..< len(n):
  101. let it = n.sons[i]
  102. if it.kind in nkPragmaCallKinds and it.len == 2 and it.sons[0].kind == nkIdent:
  103. case whichKeyword(it.sons[0].ident)
  104. of wSubsChar:
  105. if it.sons[1].kind == nkCharLit: result = chr(int(it.sons[1].intVal))
  106. else: invalidPragma(c, it)
  107. else: invalidPragma(c, it)
  108. else:
  109. invalidPragma(c, it)
  110. proc setExternName(c: PContext; s: PSym, extname: string, info: TLineInfo) =
  111. # special cases to improve performance:
  112. if extname == "$1":
  113. s.loc.r = rope(s.name.s)
  114. elif '$' notin extname:
  115. s.loc.r = rope(extname)
  116. else:
  117. try:
  118. s.loc.r = rope(extname % s.name.s)
  119. except ValueError:
  120. localError(c.config, info, "invalid extern name: '" & extname & "'. (Forgot to escape '$'?)")
  121. if c.config.cmd == cmdPretty and '$' notin extname:
  122. # note that '{.importc.}' is transformed into '{.importc: "$1".}'
  123. s.loc.flags.incl(lfFullExternalName)
  124. proc makeExternImport(c: PContext; s: PSym, extname: string, info: TLineInfo) =
  125. setExternName(c, s, extname, info)
  126. incl(s.flags, sfImportc)
  127. excl(s.flags, sfForward)
  128. proc makeExternExport(c: PContext; s: PSym, extname: string, info: TLineInfo) =
  129. setExternName(c, s, extname, info)
  130. incl(s.flags, sfExportc)
  131. proc processImportCompilerProc(c: PContext; s: PSym, extname: string, info: TLineInfo) =
  132. setExternName(c, s, extname, info)
  133. incl(s.flags, sfImportc)
  134. excl(s.flags, sfForward)
  135. incl(s.loc.flags, lfImportCompilerProc)
  136. proc processImportCpp(c: PContext; s: PSym, extname: string, info: TLineInfo) =
  137. setExternName(c, s, extname, info)
  138. incl(s.flags, sfImportc)
  139. incl(s.flags, sfInfixCall)
  140. excl(s.flags, sfForward)
  141. if c.config.cmd == cmdCompileToC:
  142. let m = s.getModule()
  143. incl(m.flags, sfCompileToCpp)
  144. incl c.config.globalOptions, optMixedMode
  145. proc processImportObjC(c: PContext; s: PSym, extname: string, info: TLineInfo) =
  146. setExternName(c, s, extname, info)
  147. incl(s.flags, sfImportc)
  148. incl(s.flags, sfNamedParamCall)
  149. excl(s.flags, sfForward)
  150. let m = s.getModule()
  151. incl(m.flags, sfCompileToObjc)
  152. proc newEmptyStrNode(c: PContext; n: PNode): PNode {.noinline.} =
  153. result = newNodeIT(nkStrLit, n.info, getSysType(c.graph, n.info, tyString))
  154. result.strVal = ""
  155. proc getStrLitNode(c: PContext, n: PNode): PNode =
  156. if n.kind notin nkPragmaCallKinds or n.len != 2:
  157. localError(c.config, n.info, errStringLiteralExpected)
  158. # error correction:
  159. result = newEmptyStrNode(c, n)
  160. else:
  161. n.sons[1] = c.semConstExpr(c, n.sons[1])
  162. case n.sons[1].kind
  163. of nkStrLit, nkRStrLit, nkTripleStrLit: result = n.sons[1]
  164. else:
  165. localError(c.config, n.info, errStringLiteralExpected)
  166. # error correction:
  167. result = newEmptyStrNode(c, n)
  168. proc expectStrLit(c: PContext, n: PNode): string =
  169. result = getStrLitNode(c, n).strVal
  170. proc expectIntLit(c: PContext, n: PNode): int =
  171. if n.kind notin nkPragmaCallKinds or n.len != 2:
  172. localError(c.config, n.info, errIntLiteralExpected)
  173. else:
  174. n.sons[1] = c.semConstExpr(c, n.sons[1])
  175. case n.sons[1].kind
  176. of nkIntLit..nkInt64Lit: result = int(n.sons[1].intVal)
  177. else: localError(c.config, n.info, errIntLiteralExpected)
  178. proc getOptionalStr(c: PContext, n: PNode, defaultStr: string): string =
  179. if n.kind in nkPragmaCallKinds: result = expectStrLit(c, n)
  180. else: result = defaultStr
  181. proc processCodegenDecl(c: PContext, n: PNode, sym: PSym) =
  182. sym.constraint = getStrLitNode(c, n)
  183. proc processMagic(c: PContext, n: PNode, s: PSym) =
  184. #if sfSystemModule notin c.module.flags:
  185. # liMessage(n.info, errMagicOnlyInSystem)
  186. if n.kind notin nkPragmaCallKinds or n.len != 2:
  187. localError(c.config, n.info, errStringLiteralExpected)
  188. return
  189. var v: string
  190. if n.sons[1].kind == nkIdent: v = n.sons[1].ident.s
  191. else: v = expectStrLit(c, n)
  192. for m in low(TMagic) .. high(TMagic):
  193. if substr($m, 1) == v:
  194. s.magic = m
  195. break
  196. if s.magic == mNone: message(c.config, n.info, warnUnknownMagic, v)
  197. proc wordToCallConv(sw: TSpecialWord): TCallingConvention =
  198. # this assumes that the order of special words and calling conventions is
  199. # the same
  200. result = TCallingConvention(ord(ccDefault) + ord(sw) - ord(wNimcall))
  201. proc isTurnedOn(c: PContext, n: PNode): bool =
  202. if n.kind in nkPragmaCallKinds and n.len == 2:
  203. let x = c.semConstBoolExpr(c, n.sons[1])
  204. n.sons[1] = x
  205. if x.kind == nkIntLit: return x.intVal != 0
  206. localError(c.config, n.info, "'on' or 'off' expected")
  207. proc onOff(c: PContext, n: PNode, op: TOptions, resOptions: var TOptions) =
  208. if isTurnedOn(c, n): resOptions = resOptions + op
  209. else: resOptions = resOptions - op
  210. proc pragmaNoForward(c: PContext, n: PNode; flag=sfNoForward) =
  211. if isTurnedOn(c, n):
  212. incl(c.module.flags, flag)
  213. c.features.incl codeReordering
  214. else:
  215. excl(c.module.flags, flag)
  216. # c.features.excl codeReordering
  217. # deprecated as of 0.18.1
  218. message(c.config, n.info, warnDeprecated,
  219. "use {.experimental: \"codeReordering\".} instead; " &
  220. (if flag == sfNoForward: "{.noForward.}" else: "{.reorder.}") & " is deprecated")
  221. proc processCallConv(c: PContext, n: PNode) =
  222. if n.kind in nkPragmaCallKinds and n.len == 2 and n.sons[1].kind == nkIdent:
  223. let sw = whichKeyword(n.sons[1].ident)
  224. case sw
  225. of FirstCallConv..LastCallConv:
  226. c.optionStack[^1].defaultCC = wordToCallConv(sw)
  227. else: localError(c.config, n.info, "calling convention expected")
  228. else:
  229. localError(c.config, n.info, "calling convention expected")
  230. proc getLib(c: PContext, kind: TLibKind, path: PNode): PLib =
  231. for it in c.libs:
  232. if it.kind == kind and trees.exprStructuralEquivalent(it.path, path):
  233. return it
  234. result = newLib(kind)
  235. result.path = path
  236. c.libs.add result
  237. if path.kind in {nkStrLit..nkTripleStrLit}:
  238. result.isOverriden = options.isDynlibOverride(c.config, path.strVal)
  239. proc expectDynlibNode(c: PContext, n: PNode): PNode =
  240. if n.kind notin nkPragmaCallKinds or n.len != 2:
  241. localError(c.config, n.info, errStringLiteralExpected)
  242. # error correction:
  243. result = newEmptyStrNode(c, n)
  244. else:
  245. # For the OpenGL wrapper we support:
  246. # {.dynlib: myGetProcAddr(...).}
  247. result = c.semExpr(c, n.sons[1])
  248. if result.kind == nkSym and result.sym.kind == skConst:
  249. result = result.sym.ast # look it up
  250. if result.typ == nil or result.typ.kind notin {tyPointer, tyString, tyProc}:
  251. localError(c.config, n.info, errStringLiteralExpected)
  252. result = newEmptyStrNode(c, n)
  253. proc processDynLib(c: PContext, n: PNode, sym: PSym) =
  254. if (sym == nil) or (sym.kind == skModule):
  255. let lib = getLib(c, libDynamic, expectDynlibNode(c, n))
  256. if not lib.isOverriden:
  257. c.optionStack[^1].dynlib = lib
  258. else:
  259. if n.kind in nkPragmaCallKinds:
  260. var lib = getLib(c, libDynamic, expectDynlibNode(c, n))
  261. if not lib.isOverriden:
  262. addToLib(lib, sym)
  263. incl(sym.loc.flags, lfDynamicLib)
  264. else:
  265. incl(sym.loc.flags, lfExportLib)
  266. # since we'll be loading the dynlib symbols dynamically, we must use
  267. # a calling convention that doesn't introduce custom name mangling
  268. # cdecl is the default - the user can override this explicitly
  269. if sym.kind in routineKinds and sym.typ != nil and
  270. sym.typ.callConv == ccDefault:
  271. sym.typ.callConv = ccCDecl
  272. proc processNote(c: PContext, n: PNode) =
  273. if n.kind in nkPragmaCallKinds and len(n) == 2 and
  274. n[0].kind == nkBracketExpr and
  275. n[0].len == 2 and
  276. n[0][1].kind == nkIdent and n[0][0].kind == nkIdent:
  277. var nk: TNoteKind
  278. case whichKeyword(n[0][0].ident)
  279. of wHint:
  280. var x = findStr(HintsToStr, n[0][1].ident.s)
  281. if x >= 0: nk = TNoteKind(x + ord(hintMin))
  282. else: invalidPragma(c, n); return
  283. of wWarning:
  284. var x = findStr(WarningsToStr, n[0][1].ident.s)
  285. if x >= 0: nk = TNoteKind(x + ord(warnMin))
  286. else: invalidPragma(c, n); return
  287. else:
  288. invalidPragma(c, n)
  289. return
  290. let x = c.semConstBoolExpr(c, n[1])
  291. n.sons[1] = x
  292. if x.kind == nkIntLit and x.intVal != 0: incl(c.config.notes, nk)
  293. else: excl(c.config.notes, nk)
  294. else:
  295. invalidPragma(c, n)
  296. proc pragmaToOptions(w: TSpecialWord): TOptions {.inline.} =
  297. case w
  298. of wChecks: ChecksOptions
  299. of wObjChecks: {optObjCheck}
  300. of wFieldChecks: {optFieldCheck}
  301. of wRangeChecks: {optRangeCheck}
  302. of wBoundChecks: {optBoundsCheck}
  303. of wOverflowChecks: {optOverflowCheck}
  304. of wNilChecks: {optNilCheck}
  305. of wFloatChecks: {optNaNCheck, optInfCheck}
  306. of wNanChecks: {optNaNCheck}
  307. of wInfChecks: {optInfCheck}
  308. of wStyleChecks: {optStyleCheck}
  309. of wAssertions: {optAssert}
  310. of wWarnings: {optWarns}
  311. of wHints: {optHints}
  312. of wLineDir: {optLineDir}
  313. of wStackTrace: {optStackTrace}
  314. of wLineTrace: {optLineTrace}
  315. of wDebugger: {optNone}
  316. of wProfiler: {optProfiler, optMemTracker}
  317. of wMemTracker: {optMemTracker}
  318. of wByRef: {optByRef}
  319. of wImplicitStatic: {optImplicitStatic}
  320. of wPatterns, wTrMacros: {optTrMacros}
  321. else: {}
  322. proc processExperimental(c: PContext; n: PNode) =
  323. if n.kind notin nkPragmaCallKinds or n.len != 2:
  324. c.features.incl oldExperimentalFeatures
  325. else:
  326. n[1] = c.semConstExpr(c, n[1])
  327. case n[1].kind
  328. of nkStrLit, nkRStrLit, nkTripleStrLit:
  329. try:
  330. let feature = parseEnum[Feature](n[1].strVal)
  331. c.features.incl feature
  332. if feature == codeReordering:
  333. if not isTopLevel(c):
  334. localError(c.config, n.info,
  335. "Code reordering experimental pragma only valid at toplevel")
  336. c.module.flags.incl sfReorder
  337. except ValueError:
  338. localError(c.config, n[1].info, "unknown experimental feature")
  339. else:
  340. localError(c.config, n.info, errStringLiteralExpected)
  341. proc tryProcessOption(c: PContext, n: PNode, resOptions: var TOptions): bool =
  342. result = true
  343. if n.kind notin nkPragmaCallKinds or n.len != 2: result = false
  344. elif n.sons[0].kind == nkBracketExpr: processNote(c, n)
  345. elif n.sons[0].kind != nkIdent: result = false
  346. else:
  347. let sw = whichKeyword(n.sons[0].ident)
  348. if sw == wExperimental:
  349. processExperimental(c, n)
  350. return true
  351. let opts = pragmaToOptions(sw)
  352. if opts != {}:
  353. onOff(c, n, opts, resOptions)
  354. else:
  355. case sw
  356. of wCallconv: processCallConv(c, n)
  357. of wDynlib: processDynLib(c, n, nil)
  358. of wOptimization:
  359. if n.sons[1].kind != nkIdent:
  360. invalidPragma(c, n)
  361. else:
  362. case n.sons[1].ident.s.normalize
  363. of "speed":
  364. incl(resOptions, optOptimizeSpeed)
  365. excl(resOptions, optOptimizeSize)
  366. of "size":
  367. excl(resOptions, optOptimizeSpeed)
  368. incl(resOptions, optOptimizeSize)
  369. of "none":
  370. excl(resOptions, optOptimizeSpeed)
  371. excl(resOptions, optOptimizeSize)
  372. else: localError(c.config, n.info, "'none', 'speed' or 'size' expected")
  373. else: result = false
  374. proc processOption(c: PContext, n: PNode, resOptions: var TOptions) =
  375. if not tryProcessOption(c, n, resOptions):
  376. # calling conventions (boring...):
  377. localError(c.config, n.info, "option expected")
  378. proc processPush(c: PContext, n: PNode, start: int) =
  379. if n.sons[start-1].kind in nkPragmaCallKinds:
  380. localError(c.config, n.info, "'push' cannot have arguments")
  381. var x = pushOptionEntry(c)
  382. for i in start ..< len(n):
  383. if not tryProcessOption(c, n.sons[i], c.config.options):
  384. # simply store it somewhere:
  385. if x.otherPragmas.isNil:
  386. x.otherPragmas = newNodeI(nkPragma, n.info)
  387. x.otherPragmas.add n.sons[i]
  388. #localError(c.config, n.info, errOptionExpected)
  389. # If stacktrace is disabled globally we should not enable it
  390. if optStackTrace notin c.optionStack[0].options:
  391. c.config.options.excl(optStackTrace)
  392. when defined(debugOptions):
  393. echo c.config $ n.info, " PUSH config is now ", c.config.options
  394. proc processPop(c: PContext, n: PNode) =
  395. if c.optionStack.len <= 1:
  396. localError(c.config, n.info, "{.pop.} without a corresponding {.push.}")
  397. else:
  398. popOptionEntry(c)
  399. when defined(debugOptions):
  400. echo c.config $ n.info, " POP config is now ", c.config.options
  401. proc processDefine(c: PContext, n: PNode) =
  402. if (n.kind in nkPragmaCallKinds and n.len == 2) and (n[1].kind == nkIdent):
  403. defineSymbol(c.config.symbols, n[1].ident.s)
  404. message(c.config, n.info, warnDeprecated, "define is deprecated")
  405. else:
  406. invalidPragma(c, n)
  407. proc processUndef(c: PContext, n: PNode) =
  408. if (n.kind in nkPragmaCallKinds and n.len == 2) and (n[1].kind == nkIdent):
  409. undefSymbol(c.config.symbols, n[1].ident.s)
  410. message(c.config, n.info, warnDeprecated, "undef is deprecated")
  411. else:
  412. invalidPragma(c, n)
  413. proc relativeFile(c: PContext; n: PNode; ext=""): AbsoluteFile =
  414. var s = expectStrLit(c, n)
  415. if ext.len > 0 and splitFile(s).ext == "":
  416. s = addFileExt(s, ext)
  417. result = AbsoluteFile parentDir(toFullPath(c.config, n.info)) / s
  418. if not fileExists(result):
  419. if isAbsolute(s): result = AbsoluteFile s
  420. else:
  421. result = findFile(c.config, s)
  422. if result.isEmpty: result = AbsoluteFile s
  423. proc processCompile(c: PContext, n: PNode) =
  424. proc docompile(c: PContext; it: PNode; src, dest: AbsoluteFile) =
  425. var cf = Cfile(nimname: splitFile(src).name,
  426. cname: src, obj: dest, flags: {CfileFlag.External})
  427. extccomp.addExternalFileToCompile(c.config, cf)
  428. recordPragma(c, it, "compile", src.string, dest.string)
  429. proc getStrLit(c: PContext, n: PNode; i: int): string =
  430. n.sons[i] = c.semConstExpr(c, n[i])
  431. case n[i].kind
  432. of nkStrLit, nkRStrLit, nkTripleStrLit:
  433. shallowCopy(result, n[i].strVal)
  434. else:
  435. localError(c.config, n.info, errStringLiteralExpected)
  436. result = ""
  437. let it = if n.kind in nkPragmaCallKinds and n.len == 2: n.sons[1] else: n
  438. if it.kind in {nkPar, nkTupleConstr} and it.len == 2:
  439. let s = getStrLit(c, it, 0)
  440. let dest = getStrLit(c, it, 1)
  441. var found = parentDir(toFullPath(c.config, n.info)) / s
  442. for f in os.walkFiles(found):
  443. let obj = completeCfilePath(c.config, AbsoluteFile(dest % extractFilename(f)))
  444. docompile(c, it, AbsoluteFile f, obj)
  445. else:
  446. let s = expectStrLit(c, n)
  447. var found = AbsoluteFile(parentDir(toFullPath(c.config, n.info)) / s)
  448. if not fileExists(found):
  449. if isAbsolute(s): found = AbsoluteFile s
  450. else:
  451. found = findFile(c.config, s)
  452. if found.isEmpty: found = AbsoluteFile s
  453. let obj = toObjFile(c.config, completeCfilePath(c.config, found, false))
  454. docompile(c, it, found, obj)
  455. proc processLink(c: PContext, n: PNode) =
  456. let found = relativeFile(c, n, CC[c.config.cCompiler].objExt)
  457. extccomp.addExternalFileToLink(c.config, found)
  458. recordPragma(c, n, "link", found.string)
  459. proc semAsmOrEmit*(con: PContext, n: PNode, marker: char): PNode =
  460. case n.sons[1].kind
  461. of nkStrLit, nkRStrLit, nkTripleStrLit:
  462. result = newNode(if n.kind == nkAsmStmt: nkAsmStmt else: nkArgList, n.info)
  463. var str = n.sons[1].strVal
  464. if str == "":
  465. localError(con.config, n.info, "empty 'asm' statement")
  466. return
  467. # now parse the string literal and substitute symbols:
  468. var a = 0
  469. while true:
  470. var b = strutils.find(str, marker, a)
  471. var sub = if b < 0: substr(str, a) else: substr(str, a, b - 1)
  472. if sub != "": addSon(result, newStrNode(nkStrLit, sub))
  473. if b < 0: break
  474. var c = strutils.find(str, marker, b + 1)
  475. if c < 0: sub = substr(str, b + 1)
  476. else: sub = substr(str, b + 1, c - 1)
  477. if sub != "":
  478. var e = searchInScopes(con, getIdent(con.cache, sub))
  479. if e != nil:
  480. when false:
  481. if e.kind == skStub: loadStub(e)
  482. incl(e.flags, sfUsed)
  483. addSon(result, newSymNode(e))
  484. else:
  485. addSon(result, newStrNode(nkStrLit, sub))
  486. else:
  487. # an empty '``' produces a single '`'
  488. addSon(result, newStrNode(nkStrLit, $marker))
  489. if c < 0: break
  490. a = c + 1
  491. else:
  492. illFormedAstLocal(n, con.config)
  493. result = newNode(nkAsmStmt, n.info)
  494. proc pragmaEmit(c: PContext, n: PNode) =
  495. if n.kind notin nkPragmaCallKinds or n.len != 2:
  496. localError(c.config, n.info, errStringLiteralExpected)
  497. else:
  498. let n1 = n[1]
  499. if n1.kind == nkBracket:
  500. var b = newNodeI(nkBracket, n1.info, n1.len)
  501. for i in 0..<n1.len:
  502. b.sons[i] = c.semExpr(c, n1[i])
  503. n.sons[1] = b
  504. else:
  505. n.sons[1] = c.semConstExpr(c, n1)
  506. case n.sons[1].kind
  507. of nkStrLit, nkRStrLit, nkTripleStrLit:
  508. n.sons[1] = semAsmOrEmit(c, n, '`')
  509. else:
  510. localError(c.config, n.info, errStringLiteralExpected)
  511. proc noVal(c: PContext; n: PNode) =
  512. if n.kind in nkPragmaCallKinds and n.len > 1: invalidPragma(c, n)
  513. proc pragmaUnroll(c: PContext, n: PNode) =
  514. if c.p.nestedLoopCounter <= 0:
  515. invalidPragma(c, n)
  516. elif n.kind in nkPragmaCallKinds and n.len == 2:
  517. var unrollFactor = expectIntLit(c, n)
  518. if unrollFactor <% 32:
  519. n.sons[1] = newIntNode(nkIntLit, unrollFactor)
  520. else:
  521. invalidPragma(c, n)
  522. proc pragmaLine(c: PContext, n: PNode) =
  523. if n.kind in nkPragmaCallKinds and n.len == 2:
  524. n.sons[1] = c.semConstExpr(c, n.sons[1])
  525. let a = n.sons[1]
  526. if a.kind in {nkPar, nkTupleConstr}:
  527. # unpack the tuple
  528. var x = a.sons[0]
  529. var y = a.sons[1]
  530. if x.kind == nkExprColonExpr: x = x.sons[1]
  531. if y.kind == nkExprColonExpr: y = y.sons[1]
  532. if x.kind != nkStrLit:
  533. localError(c.config, n.info, errStringLiteralExpected)
  534. elif y.kind != nkIntLit:
  535. localError(c.config, n.info, errIntLiteralExpected)
  536. else:
  537. n.info.fileIndex = fileInfoIdx(c.config, AbsoluteFile(x.strVal))
  538. n.info.line = uint16(y.intVal)
  539. else:
  540. localError(c.config, n.info, "tuple expected")
  541. else:
  542. # sensible default:
  543. n.info = getInfoContext(c.config, -1)
  544. proc processPragma(c: PContext, n: PNode, i: int) =
  545. let it = n[i]
  546. if it.kind notin nkPragmaCallKinds and it.safeLen == 2: invalidPragma(c, n)
  547. elif it.safeLen != 2 or it[0].kind != nkIdent or it[1].kind != nkIdent:
  548. invalidPragma(c, n)
  549. var userPragma = newSym(skTemplate, it[1].ident, nil, it.info, c.config.options)
  550. userPragma.ast = newNode(nkPragma, n.info, n.sons[i+1..^1])
  551. strTableAdd(c.userPragmas, userPragma)
  552. proc pragmaRaisesOrTags(c: PContext, n: PNode) =
  553. proc processExc(c: PContext, x: PNode) =
  554. var t = skipTypes(c.semTypeNode(c, x, nil), skipPtrs)
  555. if t.kind != tyObject:
  556. localError(c.config, x.info, errGenerated, "invalid type for raises/tags list")
  557. x.typ = t
  558. if n.kind in nkPragmaCallKinds and n.len == 2:
  559. let it = n.sons[1]
  560. if it.kind notin {nkCurly, nkBracket}:
  561. processExc(c, it)
  562. else:
  563. for e in items(it): processExc(c, e)
  564. else:
  565. invalidPragma(c, n)
  566. proc pragmaLockStmt(c: PContext; it: PNode) =
  567. if it.kind notin nkPragmaCallKinds or it.len != 2:
  568. invalidPragma(c, it)
  569. else:
  570. let n = it[1]
  571. if n.kind != nkBracket:
  572. localError(c.config, n.info, errGenerated, "locks pragma takes a list of expressions")
  573. else:
  574. for i in 0 ..< n.len:
  575. n.sons[i] = c.semExpr(c, n.sons[i])
  576. proc pragmaLocks(c: PContext, it: PNode): TLockLevel =
  577. if it.kind notin nkPragmaCallKinds or it.len != 2:
  578. invalidPragma(c, it)
  579. else:
  580. case it[1].kind
  581. of nkStrLit, nkRStrLit, nkTripleStrLit:
  582. if it[1].strVal == "unknown":
  583. result = UnknownLockLevel
  584. else:
  585. localError(c.config, it[1].info, "invalid string literal for locks pragma (only allowed string is \"unknown\")")
  586. else:
  587. let x = expectIntLit(c, it)
  588. if x < 0 or x > MaxLockLevel:
  589. localError(c.config, it[1].info, "integer must be within 0.." & $MaxLockLevel)
  590. else:
  591. result = TLockLevel(x)
  592. proc typeBorrow(c: PContext; sym: PSym, n: PNode) =
  593. if n.kind in nkPragmaCallKinds and n.len == 2:
  594. let it = n.sons[1]
  595. if it.kind != nkAccQuoted:
  596. localError(c.config, n.info, "a type can only borrow `.` for now")
  597. incl(sym.typ.flags, tfBorrowDot)
  598. proc markCompilerProc(c: PContext; s: PSym) =
  599. # minor hack ahead: FlowVar is the only generic .compilerProc type which
  600. # should not have an external name set:
  601. if s.kind != skType or s.name.s != "FlowVar":
  602. makeExternExport(c, s, "$1", s.info)
  603. incl(s.flags, sfCompilerProc)
  604. incl(s.flags, sfUsed)
  605. registerCompilerProc(c.graph, s)
  606. proc deprecatedStmt(c: PContext; outerPragma: PNode) =
  607. let pragma = outerPragma[1]
  608. if pragma.kind in {nkStrLit..nkTripleStrLit}:
  609. incl(c.module.flags, sfDeprecated)
  610. c.module.constraint = getStrLitNode(c, outerPragma)
  611. return
  612. if pragma.kind != nkBracket:
  613. localError(c.config, pragma.info, "list of key:value pairs expected"); return
  614. for n in pragma:
  615. if n.kind in nkPragmaCallKinds and n.len == 2:
  616. let dest = qualifiedLookUp(c, n[1], {checkUndeclared})
  617. if dest == nil or dest.kind in routineKinds:
  618. localError(c.config, n.info, warnUser, "the .deprecated pragma is unreliable for routines")
  619. let src = considerQuotedIdent(c, n[0])
  620. let alias = newSym(skAlias, src, dest, n[0].info, c.config.options)
  621. incl(alias.flags, sfExported)
  622. if sfCompilerProc in dest.flags: markCompilerProc(c, alias)
  623. addInterfaceDecl(c, alias)
  624. n.sons[1] = newSymNode(dest)
  625. else:
  626. localError(c.config, n.info, "key:value pair expected")
  627. proc pragmaGuard(c: PContext; it: PNode; kind: TSymKind): PSym =
  628. if it.kind notin nkPragmaCallKinds or it.len != 2:
  629. invalidPragma(c, it); return
  630. let n = it[1]
  631. if n.kind == nkSym:
  632. result = n.sym
  633. elif kind == skField:
  634. # First check if the guard is a global variable:
  635. result = qualifiedLookUp(c, n, {})
  636. if result.isNil or result.kind notin {skLet, skVar} or
  637. sfGlobal notin result.flags:
  638. # We return a dummy symbol; later passes over the type will repair it.
  639. # Generic instantiation needs to know about this too. But we're lazy
  640. # and perform the lookup on demand instead.
  641. result = newSym(skUnknown, considerQuotedIdent(c, n), nil, n.info,
  642. c.config.options)
  643. else:
  644. result = qualifiedLookUp(c, n, {checkUndeclared})
  645. proc semCustomPragma(c: PContext, n: PNode): PNode =
  646. var callNode: PNode
  647. if n.kind in {nkIdent, nkSym}:
  648. # pragma -> pragma()
  649. callNode = newTree(nkCall, n)
  650. elif n.kind == nkExprColonExpr:
  651. # pragma: arg -> pragma(arg)
  652. callNode = newTree(nkCall, n[0], n[1])
  653. elif n.kind in nkPragmaCallKinds:
  654. callNode = n
  655. else:
  656. invalidPragma(c, n)
  657. return n
  658. let r = c.semOverloadedCall(c, callNode, n, {skTemplate}, {efNoUndeclared})
  659. if r.isNil or sfCustomPragma notin r[0].sym.flags:
  660. invalidPragma(c, n)
  661. return n
  662. result = r
  663. # Transform the nkCall node back to its original form if possible
  664. if n.kind == nkIdent and r.len == 1:
  665. # pragma() -> pragma
  666. result = result[0]
  667. elif n.kind == nkExprColonExpr and r.len == 2:
  668. # pragma(arg) -> pragma: arg
  669. result.kind = n.kind
  670. proc singlePragma(c: PContext, sym: PSym, n: PNode, i: var int,
  671. validPragmas: TSpecialWords,
  672. comesFromPush, isStatement: bool) : bool =
  673. var it = n.sons[i]
  674. var key = if it.kind in nkPragmaCallKinds and it.len > 1: it.sons[0] else: it
  675. if key.kind == nkBracketExpr:
  676. processNote(c, it)
  677. return
  678. elif key.kind notin nkIdentKinds:
  679. n.sons[i] = semCustomPragma(c, it)
  680. return
  681. let ident = considerQuotedIdent(c, key)
  682. var userPragma = strTableGet(c.userPragmas, ident)
  683. if userPragma != nil:
  684. if {optStyleHint, optStyleError} * c.config.globalOptions != {}:
  685. styleCheckUse(c.config, key.info, userPragma)
  686. # number of pragmas increase/decrease with user pragma expansion
  687. inc c.instCounter
  688. if c.instCounter > 100:
  689. globalError(c.config, it.info, "recursive dependency: " & userPragma.name.s)
  690. pragma(c, sym, userPragma.ast, validPragmas, isStatement)
  691. n.sons[i..i] = userPragma.ast.sons # expand user pragma with its content
  692. i.inc(userPragma.ast.len - 1) # inc by -1 is ok, user pragmas was empty
  693. dec c.instCounter
  694. else:
  695. let k = whichKeyword(ident)
  696. if k in validPragmas:
  697. if {optStyleHint, optStyleError} * c.config.globalOptions != {}:
  698. checkPragmaUse(c.config, key.info, k, ident.s)
  699. case k
  700. of wExportc, wExportCpp:
  701. makeExternExport(c, sym, getOptionalStr(c, it, "$1"), it.info)
  702. if k == wExportCpp:
  703. if c.config.cmd != cmdCompileToCpp:
  704. localError(c.config, it.info, "exportcpp requires `nim cpp`, got " & $c.config.cmd)
  705. else:
  706. incl(sym.flags, sfMangleCpp)
  707. incl(sym.flags, sfUsed) # avoid wrong hints
  708. of wImportc:
  709. let name = getOptionalStr(c, it, "$1")
  710. cppDefine(c.config, name)
  711. recordPragma(c, it, "cppdefine", name)
  712. makeExternImport(c, sym, name, it.info)
  713. of wImportCompilerProc:
  714. let name = getOptionalStr(c, it, "$1")
  715. cppDefine(c.config, name)
  716. recordPragma(c, it, "cppdefine", name)
  717. processImportCompilerProc(c, sym, name, it.info)
  718. of wExtern: setExternName(c, sym, expectStrLit(c, it), it.info)
  719. of wDirty:
  720. if sym.kind == skTemplate: incl(sym.flags, sfDirty)
  721. else: invalidPragma(c, it)
  722. of wImportCpp:
  723. processImportCpp(c, sym, getOptionalStr(c, it, "$1"), it.info)
  724. of wImportJs:
  725. if c.config.cmd != cmdCompileToJS:
  726. localError(c.config, it.info, "`importjs` pragma requires the JavaScript target")
  727. let name = getOptionalStr(c, it, "$1")
  728. incl(sym.flags, sfImportc)
  729. incl(sym.flags, sfInfixCall)
  730. if sym.kind in skProcKinds and {'(', '#', '@'} notin name:
  731. localError(c.config, n.info, "`importjs` for routines requires a pattern")
  732. setExternName(c, sym, name, it.info)
  733. of wImportObjC:
  734. processImportObjC(c, sym, getOptionalStr(c, it, "$1"), it.info)
  735. of wAlign:
  736. if sym.typ == nil: invalidPragma(c, it)
  737. var align = expectIntLit(c, it)
  738. if (not isPowerOfTwo(align) and align != 0) or align >% high(int16):
  739. localError(c.config, it.info, "power of two expected")
  740. else:
  741. sym.typ.align = align.int16
  742. of wSize:
  743. if sym.typ == nil: invalidPragma(c, it)
  744. var size = expectIntLit(c, it)
  745. case size
  746. of 1, 2, 4:
  747. sym.typ.size = size
  748. sym.typ.align = int16 size
  749. of 8:
  750. sym.typ.size = 8
  751. sym.typ.align = floatInt64Align(c.config)
  752. else:
  753. localError(c.config, it.info, "size may only be 1, 2, 4 or 8")
  754. of wNodecl:
  755. noVal(c, it)
  756. incl(sym.loc.flags, lfNoDecl)
  757. of wPure, wAsmNoStackFrame:
  758. noVal(c, it)
  759. if sym != nil:
  760. if k == wPure and sym.kind in routineKinds: invalidPragma(c, it)
  761. else: incl(sym.flags, sfPure)
  762. of wVolatile:
  763. noVal(c, it)
  764. incl(sym.flags, sfVolatile)
  765. of wRegister:
  766. noVal(c, it)
  767. incl(sym.flags, sfRegister)
  768. of wThreadVar:
  769. noVal(c, it)
  770. incl(sym.flags, {sfThread, sfGlobal})
  771. of wDeadCodeElimUnused: discard # deprecated, dead code elim always on
  772. of wNoForward: pragmaNoForward(c, it)
  773. of wReorder: pragmaNoForward(c, it, flag = sfReorder)
  774. of wMagic: processMagic(c, it, sym)
  775. of wCompileTime:
  776. noVal(c, it)
  777. incl(sym.flags, sfCompileTime)
  778. #incl(sym.loc.flags, lfNoDecl)
  779. of wGlobal:
  780. noVal(c, it)
  781. incl(sym.flags, sfGlobal)
  782. incl(sym.flags, sfPure)
  783. of wMerge:
  784. # only supported for backwards compat, doesn't do anything anymore
  785. noVal(c, it)
  786. of wConstructor:
  787. noVal(c, it)
  788. incl(sym.flags, sfConstructor)
  789. of wHeader:
  790. var lib = getLib(c, libHeader, getStrLitNode(c, it))
  791. addToLib(lib, sym)
  792. incl(sym.flags, sfImportc)
  793. incl(sym.loc.flags, lfHeader)
  794. incl(sym.loc.flags, lfNoDecl)
  795. # implies nodecl, because otherwise header would not make sense
  796. if sym.loc.r == nil: sym.loc.r = rope(sym.name.s)
  797. of wNoSideEffect:
  798. noVal(c, it)
  799. if sym != nil:
  800. incl(sym.flags, sfNoSideEffect)
  801. if sym.typ != nil: incl(sym.typ.flags, tfNoSideEffect)
  802. of wSideEffect:
  803. noVal(c, it)
  804. incl(sym.flags, sfSideEffect)
  805. of wNoreturn:
  806. noVal(c, it)
  807. # Disable the 'noreturn' annotation when in the "Quirky Exceptions" mode!
  808. if not isDefined(c.config, "nimQuirky"):
  809. incl(sym.flags, sfNoReturn)
  810. if sym.typ[0] != nil:
  811. localError(c.config, sym.ast[paramsPos][0].info,
  812. ".noreturn with return type not allowed")
  813. of wNoDestroy:
  814. noVal(c, it)
  815. incl(sym.flags, sfGeneratedOp)
  816. of wDynlib:
  817. processDynLib(c, it, sym)
  818. of wCompilerProc, wCore:
  819. noVal(c, it) # compilerproc may not get a string!
  820. cppDefine(c.graph.config, sym.name.s)
  821. recordPragma(c, it, "cppdefine", sym.name.s)
  822. if sfFromGeneric notin sym.flags: markCompilerProc(c, sym)
  823. of wNonReloadable:
  824. sym.flags.incl sfNonReloadable
  825. of wProcVar:
  826. noVal(c, it)
  827. incl(sym.flags, sfProcvar)
  828. of wExplain:
  829. sym.flags.incl sfExplain
  830. of wDeprecated:
  831. if sym != nil and sym.kind in routineKinds + {skType, skVar, skLet}:
  832. if it.kind in nkPragmaCallKinds: discard getStrLitNode(c, it)
  833. incl(sym.flags, sfDeprecated)
  834. elif sym != nil and sym.kind != skModule:
  835. # We don't support the extra annotation field
  836. if it.kind in nkPragmaCallKinds:
  837. localError(c.config, it.info, "annotation to deprecated not supported here")
  838. incl(sym.flags, sfDeprecated)
  839. # At this point we're quite sure this is a statement and applies to the
  840. # whole module
  841. elif it.kind in nkPragmaCallKinds: deprecatedStmt(c, it)
  842. else: incl(c.module.flags, sfDeprecated)
  843. of wVarargs:
  844. noVal(c, it)
  845. if sym.typ == nil: invalidPragma(c, it)
  846. else: incl(sym.typ.flags, tfVarargs)
  847. of wBorrow:
  848. if sym.kind == skType:
  849. typeBorrow(c, sym, it)
  850. else:
  851. noVal(c, it)
  852. incl(sym.flags, sfBorrow)
  853. of wFinal:
  854. noVal(c, it)
  855. if sym.typ == nil: invalidPragma(c, it)
  856. else: incl(sym.typ.flags, tfFinal)
  857. of wInheritable:
  858. noVal(c, it)
  859. if sym.typ == nil or tfFinal in sym.typ.flags: invalidPragma(c, it)
  860. else: incl(sym.typ.flags, tfInheritable)
  861. of wPackage:
  862. noVal(c, it)
  863. if sym.typ == nil: invalidPragma(c, it)
  864. else: incl(sym.flags, sfForward)
  865. of wAcyclic:
  866. noVal(c, it)
  867. if sym.typ == nil: invalidPragma(c, it)
  868. # now: ignored
  869. of wShallow:
  870. noVal(c, it)
  871. if sym.typ == nil: invalidPragma(c, it)
  872. else: incl(sym.typ.flags, tfShallow)
  873. of wThread:
  874. noVal(c, it)
  875. incl(sym.flags, sfThread)
  876. incl(sym.flags, sfProcvar)
  877. if sym.typ != nil:
  878. incl(sym.typ.flags, tfThread)
  879. if sym.typ.callConv == ccClosure: sym.typ.callConv = ccDefault
  880. of wGcSafe:
  881. noVal(c, it)
  882. if sym != nil:
  883. if sym.kind != skType: incl(sym.flags, sfThread)
  884. if sym.typ != nil: incl(sym.typ.flags, tfGcSafe)
  885. else: invalidPragma(c, it)
  886. else:
  887. discard "no checking if used as a code block"
  888. of wPacked:
  889. noVal(c, it)
  890. if sym.typ == nil: invalidPragma(c, it)
  891. else: incl(sym.typ.flags, tfPacked)
  892. of wHint:
  893. let s = expectStrLit(c, it)
  894. recordPragma(c, it, "hint", s)
  895. message(c.config, it.info, hintUser, s)
  896. of wWarning:
  897. let s = expectStrLit(c, it)
  898. recordPragma(c, it, "warning", s)
  899. message(c.config, it.info, warnUser, s)
  900. of wError:
  901. if sym != nil and (sym.isRoutine or sym.kind == skType) and not isStatement:
  902. # This is subtle but correct: the error *statement* is only
  903. # allowed when 'wUsed' is not in validPragmas. Here this is the easiest way to
  904. # distinguish properly between
  905. # ``proc p() {.error}`` and ``proc p() = {.error: "msg".}``
  906. if it.kind in nkPragmaCallKinds: discard getStrLitNode(c, it)
  907. incl(sym.flags, sfError)
  908. excl(sym.flags, sfForward)
  909. else:
  910. let s = expectStrLit(c, it)
  911. recordPragma(c, it, "error", s)
  912. localError(c.config, it.info, errUser, s)
  913. of wFatal: fatal(c.config, it.info, errUser, expectStrLit(c, it))
  914. of wDefine: processDefine(c, it)
  915. of wUndef: processUndef(c, it)
  916. of wCompile: processCompile(c, it)
  917. of wLink: processLink(c, it)
  918. of wPassl:
  919. let s = expectStrLit(c, it)
  920. extccomp.addLinkOption(c.config, s)
  921. recordPragma(c, it, "passl", s)
  922. of wPassc:
  923. let s = expectStrLit(c, it)
  924. extccomp.addCompileOption(c.config, s)
  925. recordPragma(c, it, "passc", s)
  926. of wPush:
  927. processPush(c, n, i + 1)
  928. result = true
  929. of wPop: processPop(c, it)
  930. of wPragma:
  931. if not sym.isNil and sym.kind == skTemplate:
  932. sym.flags.incl sfCustomPragma
  933. else:
  934. processPragma(c, n, i)
  935. result = true
  936. of wDiscardable:
  937. noVal(c, it)
  938. if sym != nil: incl(sym.flags, sfDiscardable)
  939. of wNoInit:
  940. noVal(c, it)
  941. if sym != nil: incl(sym.flags, sfNoInit)
  942. of wCodegenDecl: processCodegenDecl(c, it, sym)
  943. of wChecks, wObjChecks, wFieldChecks, wRangeChecks, wBoundChecks,
  944. wOverflowChecks, wNilChecks, wAssertions, wWarnings, wHints,
  945. wLineDir, wOptimization, wStyleChecks, wCallconv, wDebugger, wProfiler,
  946. wFloatChecks, wNanChecks, wInfChecks, wPatterns, wTrMacros:
  947. processOption(c, it, c.config.options)
  948. of wStackTrace, wLineTrace:
  949. if sym.kind in {skProc, skMethod, skConverter}:
  950. processOption(c, it, sym.options)
  951. else:
  952. processOption(c, it, c.config.options)
  953. of FirstCallConv..LastCallConv:
  954. assert(sym != nil)
  955. if sym.typ == nil: invalidPragma(c, it)
  956. else: sym.typ.callConv = wordToCallConv(k)
  957. of wEmit: pragmaEmit(c, it)
  958. of wUnroll: pragmaUnroll(c, it)
  959. of wLinearScanEnd, wComputedGoto: noVal(c, it)
  960. of wEffects:
  961. # is later processed in effect analysis:
  962. noVal(c, it)
  963. of wIncompleteStruct:
  964. noVal(c, it)
  965. if sym.typ == nil: invalidPragma(c, it)
  966. else: incl(sym.typ.flags, tfIncompleteStruct)
  967. of wUnchecked:
  968. noVal(c, it)
  969. if sym.typ == nil or sym.typ.kind notin {tyArray, tyUncheckedArray}:
  970. invalidPragma(c, it)
  971. else:
  972. sym.typ.kind = tyUncheckedArray
  973. of wUnion:
  974. noVal(c, it)
  975. if sym.typ == nil: invalidPragma(c, it)
  976. else: incl(sym.typ.flags, tfUnion)
  977. of wRequiresInit:
  978. noVal(c, it)
  979. if sym.typ == nil: invalidPragma(c, it)
  980. else: incl(sym.typ.flags, tfNeedsInit)
  981. of wByRef:
  982. noVal(c, it)
  983. if sym == nil or sym.typ == nil:
  984. processOption(c, it, c.config.options)
  985. else:
  986. incl(sym.typ.flags, tfByRef)
  987. of wByCopy:
  988. noVal(c, it)
  989. if sym.kind != skType or sym.typ == nil: invalidPragma(c, it)
  990. else: incl(sym.typ.flags, tfByCopy)
  991. of wPartial:
  992. noVal(c, it)
  993. if sym.kind != skType or sym.typ == nil: invalidPragma(c, it)
  994. else:
  995. incl(sym.typ.flags, tfPartial)
  996. of wInject, wGensym:
  997. # We check for errors, but do nothing with these pragmas otherwise
  998. # as they are handled directly in 'evalTemplate'.
  999. noVal(c, it)
  1000. if sym == nil: invalidPragma(c, it)
  1001. of wLine: pragmaLine(c, it)
  1002. of wRaises, wTags: pragmaRaisesOrTags(c, it)
  1003. of wLocks:
  1004. if sym == nil: pragmaLockStmt(c, it)
  1005. elif sym.typ == nil: invalidPragma(c, it)
  1006. else: sym.typ.lockLevel = pragmaLocks(c, it)
  1007. of wBitsize:
  1008. if sym == nil or sym.kind != skField:
  1009. invalidPragma(c, it)
  1010. else:
  1011. sym.bitsize = expectIntLit(c, it)
  1012. if sym.bitsize <= 0:
  1013. localError(c.config, it.info, "bitsize needs to be positive")
  1014. of wGuard:
  1015. if sym == nil or sym.kind notin {skVar, skLet, skField}:
  1016. invalidPragma(c, it)
  1017. else:
  1018. sym.guard = pragmaGuard(c, it, sym.kind)
  1019. of wGoto:
  1020. if sym == nil or sym.kind notin {skVar, skLet}:
  1021. invalidPragma(c, it)
  1022. else:
  1023. sym.flags.incl sfGoto
  1024. of wExportNims:
  1025. if sym == nil: invalidPragma(c, it)
  1026. else: magicsys.registerNimScriptSymbol(c.graph, sym)
  1027. of wInjectStmt:
  1028. if it.kind notin nkPragmaCallKinds or it.len != 2:
  1029. localError(c.config, it.info, "expression expected")
  1030. else:
  1031. it.sons[1] = c.semExpr(c, it.sons[1])
  1032. of wExperimental:
  1033. if not isTopLevel(c):
  1034. localError(c.config, n.info, "'experimental' pragma only valid as toplevel statement or in a 'push' environment")
  1035. processExperimental(c, it)
  1036. of wThis:
  1037. if it.kind in nkPragmaCallKinds and it.len == 2:
  1038. c.selfName = considerQuotedIdent(c, it[1])
  1039. message(c.config, n.info, warnDeprecated, "the '.this' pragma is deprecated")
  1040. elif it.kind == nkIdent or it.len == 1:
  1041. c.selfName = getIdent(c.cache, "self")
  1042. message(c.config, n.info, warnDeprecated, "the '.this' pragma is deprecated")
  1043. else:
  1044. localError(c.config, it.info, "'this' pragma is allowed to have zero or one arguments")
  1045. of wNoRewrite:
  1046. noVal(c, it)
  1047. of wBase:
  1048. noVal(c, it)
  1049. sym.flags.incl sfBase
  1050. of wIntDefine:
  1051. sym.magic = mIntDefine
  1052. of wStrDefine:
  1053. sym.magic = mStrDefine
  1054. of wBoolDefine:
  1055. sym.magic = mBoolDefine
  1056. of wUsed:
  1057. noVal(c, it)
  1058. if sym == nil: invalidPragma(c, it)
  1059. else: sym.flags.incl sfUsed
  1060. of wLiftLocals: discard
  1061. else: invalidPragma(c, it)
  1062. elif comesFromPush and whichKeyword(ident) in {wTags, wRaises}:
  1063. discard "ignore the .push pragma; it doesn't apply"
  1064. else:
  1065. if sym == nil or (sym.kind in {skVar, skLet, skParam,
  1066. skField, skProc, skFunc, skConverter, skMethod, skType}):
  1067. n.sons[i] = semCustomPragma(c, it)
  1068. elif sym != nil:
  1069. illegalCustomPragma(c, it, sym)
  1070. else:
  1071. invalidPragma(c, it)
  1072. proc overwriteLineInfo(n: PNode; info: TLineInfo) =
  1073. n.info = info
  1074. for i in 0..<safeLen(n):
  1075. overwriteLineInfo(n[i], info)
  1076. proc mergePragmas(n, pragmas: PNode) =
  1077. var pragmas = copyTree(pragmas)
  1078. overwriteLineInfo pragmas, n.info
  1079. if n[pragmasPos].kind == nkEmpty:
  1080. n[pragmasPos] = pragmas
  1081. else:
  1082. for p in pragmas: n.sons[pragmasPos].add p
  1083. proc implicitPragmas*(c: PContext, sym: PSym, n: PNode,
  1084. validPragmas: TSpecialWords) =
  1085. if sym != nil and sym.kind != skModule:
  1086. for it in c.optionStack:
  1087. let o = it.otherPragmas
  1088. if not o.isNil:
  1089. pushInfoContext(c.config, n.info)
  1090. var i = 0
  1091. while i < o.len:
  1092. if singlePragma(c, sym, o, i, validPragmas, true, false):
  1093. internalError(c.config, n.info, "implicitPragmas")
  1094. inc i
  1095. popInfoContext(c.config)
  1096. if sym.kind in routineKinds and sym.ast != nil: mergePragmas(sym.ast, o)
  1097. if lfExportLib in sym.loc.flags and sfExportc notin sym.flags:
  1098. localError(c.config, n.info, ".dynlib requires .exportc")
  1099. var lib = c.optionStack[^1].dynlib
  1100. if {lfDynamicLib, lfHeader} * sym.loc.flags == {} and
  1101. sfImportc in sym.flags and lib != nil:
  1102. incl(sym.loc.flags, lfDynamicLib)
  1103. addToLib(lib, sym)
  1104. if sym.loc.r == nil: sym.loc.r = rope(sym.name.s)
  1105. proc hasPragma*(n: PNode, pragma: TSpecialWord): bool =
  1106. if n == nil: return false
  1107. for p in n:
  1108. var key = if p.kind in nkPragmaCallKinds and p.len > 1: p[0] else: p
  1109. if key.kind == nkIdent and whichKeyword(key.ident) == pragma:
  1110. return true
  1111. return false
  1112. proc pragmaRec(c: PContext, sym: PSym, n: PNode, validPragmas: TSpecialWords;
  1113. isStatement: bool) =
  1114. if n == nil: return
  1115. var i = 0
  1116. while i < n.len:
  1117. if singlePragma(c, sym, n, i, validPragmas, false, isStatement): break
  1118. inc i
  1119. proc pragma(c: PContext, sym: PSym, n: PNode, validPragmas: TSpecialWords;
  1120. isStatement: bool) =
  1121. if n == nil: return
  1122. pragmaRec(c, sym, n, validPragmas, isStatement)
  1123. implicitPragmas(c, sym, n, validPragmas)