meta.json 35 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274
  1. [
  2. {
  3. "name": "Abi",
  4. "metadata": ":abi",
  5. "doc": "Function ABI/calling convention.",
  6. "platforms": ["cpp"]
  7. },
  8. {
  9. "name": "Abstract",
  10. "metadata": ":abstract",
  11. "doc": "Sets the underlying class implementation as `abstract`.",
  12. "platforms": ["java", "cs"]
  13. },
  14. {
  15. "name": "Access",
  16. "metadata": ":access",
  17. "doc": "Forces private access to package, type or field.",
  18. "params": ["Target path"],
  19. "targets": ["TClass", "TClassField"],
  20. "links": ["https://haxe.org/manual/lf-access-control.html"]
  21. },
  22. {
  23. "name": "Accessor",
  24. "metadata": ":accessor",
  25. "doc": "Used internally by DCE to mark property accessors.",
  26. "targets": ["TClassField"],
  27. "internal": true
  28. },
  29. {
  30. "name": "Allow",
  31. "metadata": ":allow",
  32. "doc": "Allows private access from package, type or field.",
  33. "params": ["Target path"],
  34. "links": ["https://haxe.org/manual/lf-access-control.html"]
  35. },
  36. {
  37. "name": "Analyzer",
  38. "metadata": ":analyzer",
  39. "doc": "Used to configure the static analyzer."
  40. },
  41. {
  42. "name": "Annotation",
  43. "metadata": ":annotation",
  44. "doc": "Annotation (`@interface`) definitions on `--java-lib` imports will be annotated with this metadata. Has no effect on types compiled by Haxe.",
  45. "platforms": ["java"],
  46. "targets": ["TClass"]
  47. },
  48. {
  49. "name": "ArrayAccess",
  50. "metadata": ":arrayAccess",
  51. "doc": "Allows array access on an abstract.",
  52. "targets": ["TAbstract", "TAbstractField"],
  53. "links": ["https://haxe.org/manual/types-abstract-array-access.html"]
  54. },
  55. {
  56. "name": "AssemblyMeta",
  57. "metadata": ":cs.assemblyMeta",
  58. "doc": "Used to declare a native C# assembly attribute",
  59. "platforms": ["cs"],
  60. "targets": ["TClass"]
  61. },
  62. {
  63. "name": "AssemblyStrict",
  64. "metadata": ":cs.assemblyStrict",
  65. "doc": "Used to declare a native C# assembly attribute; is type checked",
  66. "platforms": ["cs"],
  67. "targets": ["TClass"]
  68. },
  69. {
  70. "name": "Ast",
  71. "metadata": ":ast",
  72. "doc": "Internally used to pass the AST source into the typed AST.",
  73. "internal": true
  74. },
  75. {
  76. "name": "AstSource",
  77. "metadata": ":astSource",
  78. "doc": "Filled by the compiler with the parsed expression of the field.",
  79. "targets": ["TClassField"]
  80. },
  81. {
  82. "name": "AutoBuild",
  83. "metadata": ":autoBuild",
  84. "doc": "Extends `@:build` metadata to all extending and implementing classes.",
  85. "params": ["Build macro call"],
  86. "targets": ["TClass"],
  87. "links": ["https://haxe.org/manual/macro-auto-build.html"]
  88. },
  89. {
  90. "name": "Bind",
  91. "metadata": ":bind",
  92. "doc": "Override SWF class declaration.",
  93. "platforms": ["flash"],
  94. "targets": ["TClass"]
  95. },
  96. {
  97. "name": "Bitmap",
  98. "metadata": ":bitmap",
  99. "doc": "Embeds given bitmap data into the class (must extend `flash.display.BitmapData`).",
  100. "platforms": ["flash"],
  101. "params": ["Bitmap file path"],
  102. "targets": ["TClass"],
  103. "links": ["https://haxe.org/manual/target-flash-resources.html"]
  104. },
  105. {
  106. "name": "BridgeProperties",
  107. "metadata": ":bridgeProperties",
  108. "doc": "Creates native property bridges for all Haxe properties in this class.",
  109. "platforms": ["cs"],
  110. "targets": ["TClass"]
  111. },
  112. {
  113. "name": "Build",
  114. "metadata": ":build",
  115. "doc": "Builds a class or enum from a macro.",
  116. "params": ["Build macro call"],
  117. "targets": ["TClass", "TEnum"],
  118. "links": ["https://haxe.org/manual/macro-type-building.html"]
  119. },
  120. {
  121. "name": "BuildXml",
  122. "metadata": ":buildXml",
  123. "doc": "Specify XML data to be injected into `Build.xml`.",
  124. "platforms": ["cpp"]
  125. },
  126. {
  127. "name": "BypassAccessor",
  128. "metadata": ":bypassAccessor",
  129. "doc": "Do not call property accessor method and access the field directly.",
  130. "targets": ["TExpr"],
  131. "links": ["https://haxe.org/manual/class-field-property.html"]
  132. },
  133. {
  134. "name": "Callable",
  135. "metadata": ":callable",
  136. "doc": "Abstract forwards call to its underlying type.",
  137. "targets": ["TAbstract"]
  138. },
  139. {
  140. "name": "Class",
  141. "metadata": ":class",
  142. "doc": "Used internally to annotate an enum that will be generated as a class.",
  143. "platforms": ["java", "cs"],
  144. "targets": ["TEnum"],
  145. "internal": true
  146. },
  147. {
  148. "name": "ClassCode",
  149. "metadata": ":classCode",
  150. "doc": "Used to inject platform-native code into a class.",
  151. "platforms": ["java", "cs"],
  152. "targets": ["TClass"]
  153. },
  154. {
  155. "name": "Commutative",
  156. "metadata": ":commutative",
  157. "doc": "Declares an abstract operator as commutative.",
  158. "targets": ["TAbstractField"],
  159. "links": ["https://haxe.org/manual/types-abstract-operator-overloading.html"]
  160. },
  161. {
  162. "name": "CompilerGenerated",
  163. "metadata": ":compilerGenerated",
  164. "doc": "Marks a field as generated by the compiler. Should not be used by the end user.",
  165. "internal": true
  166. },
  167. {
  168. "name": "Const",
  169. "metadata": ":const",
  170. "doc": "Allows a type parameter to accept expression values.",
  171. "targets": ["TTypeParameter"]
  172. },
  173. {
  174. "name": "CoreApi",
  175. "metadata": ":coreApi",
  176. "doc": "Identifies this class as a core API class (forces API check).",
  177. "targets": ["TClass", "TEnum", "TTypedef", "TAbstract"]
  178. },
  179. {
  180. "name": "CoreType",
  181. "metadata": ":coreType",
  182. "doc": "Identifies an abstract as core type so that it requires no implementation.",
  183. "targets": ["TAbstract"],
  184. "links": ["https://haxe.org/manual/types-abstract-core-type.html"]
  185. },
  186. {
  187. "name": "CppFileCode",
  188. "metadata": ":cppFileCode",
  189. "doc": "Code to be injected into generated cpp file.",
  190. "platforms": ["cpp"]
  191. },
  192. {
  193. "name": "CppInclude",
  194. "metadata": ":cppInclude",
  195. "doc": "File to be included in generated cpp file.",
  196. "platforms": ["cpp"]
  197. },
  198. {
  199. "name": "CppNamespaceCode",
  200. "metadata": ":cppNamespaceCode",
  201. "doc": "",
  202. "platforms": ["cpp"]
  203. },
  204. {
  205. "name": "CsNative",
  206. "metadata": ":csNative",
  207. "doc": "Automatically added by `--net-lib` on classes generated from .NET DLL files.",
  208. "platforms": ["cs"],
  209. "targets": ["TClass", "TEnum"],
  210. "internal": true
  211. },
  212. {
  213. "name": "CsUsing",
  214. "metadata": ":cs.using",
  215. "doc": "Add using directives to your module",
  216. "platforms": ["cs"],
  217. "targets": ["TClass"]
  218. },
  219. {
  220. "name": "Dce",
  221. "metadata": ":dce",
  222. "doc": "Forces dead code elimination even when `--dce full` is not specified.",
  223. "targets": ["TClass", "TEnum"],
  224. "links": ["https://haxe.org/manual/cr-dce.html"]
  225. },
  226. {
  227. "name": "Debug",
  228. "metadata": ":debug",
  229. "doc": "Forces debug information to be generated into the SWF even without `--debug`.",
  230. "platforms": ["flash"],
  231. "targets": ["TClass", "TClassField"]
  232. },
  233. {
  234. "name": "Decl",
  235. "metadata": ":decl",
  236. "doc": "",
  237. "platforms": ["cpp"]
  238. },
  239. {
  240. "name": "DefParam",
  241. "metadata": ":defParam",
  242. "doc": "Default function argument value loaded from the SWF and used for documentation in Genxml.",
  243. "platforms": ["flash"],
  244. "internal": true
  245. },
  246. {
  247. "name": "Delegate",
  248. "metadata": ":delegate",
  249. "doc": "Automatically added by `--net-lib` on delegates.",
  250. "platforms": ["cs"],
  251. "targets": ["TAbstract"]
  252. },
  253. {
  254. "name": "Depend",
  255. "metadata": ":depend",
  256. "doc": "",
  257. "platforms": ["cpp"]
  258. },
  259. {
  260. "name": "Deprecated",
  261. "metadata": ":deprecated",
  262. "doc": "Mark a type or field as deprecated."
  263. },
  264. {
  265. "name": "DirectlyUsed",
  266. "metadata": ":directlyUsed",
  267. "doc": "Marks types that are directly referenced by non-extern code.",
  268. "internal": true
  269. },
  270. {
  271. "name": "DisplayOverride",
  272. "metadata": ":?display.override",
  273. "doc": "Internally used to mark override fields for completion",
  274. "internal": true
  275. },
  276. {
  277. "name": "DynamicObject",
  278. "metadata": ":dynamicObject",
  279. "doc": "Used internally to identify the Dynamic Object implementation.",
  280. "platforms": ["java", "cs"],
  281. "targets": ["TClass"],
  282. "internal": true
  283. },
  284. {
  285. "name": "Eager",
  286. "metadata": ":eager",
  287. "doc": "Forces typedefs to be followed early.",
  288. "targets": ["TTypedef"]
  289. },
  290. {
  291. "name": "Enum",
  292. "metadata": ":enum",
  293. "doc": "Defines finite value sets to abstract definitions.",
  294. "targets": ["TAbstract"],
  295. "links": ["https://haxe.org/manual/types-abstract-enum.html"]
  296. },
  297. {
  298. "name": "EnumConstructorParam",
  299. "metadata": ":enumConstructorParam",
  300. "doc": "Used internally to annotate GADT type parameters.",
  301. "targets": ["TClass"],
  302. "internal": true
  303. },
  304. {
  305. "name": "Event",
  306. "metadata": ":event",
  307. "doc": "Automatically added by `--net-lib` on events. Has no effect on types compiled by Haxe.",
  308. "platforms": ["cs"],
  309. "targets": ["TClassField"]
  310. },
  311. {
  312. "name": "Exhaustive",
  313. "metadata": ":exhaustive",
  314. "doc": "Used internally to mark that a switch is exhaustive.",
  315. "internal": true,
  316. "links": ["https://haxe.org/manual/lf-pattern-matching-exhaustiveness.html"]
  317. },
  318. {
  319. "name": "Expose",
  320. "metadata": ":expose",
  321. "doc": "Includes the class or field in Haxe exports (default name is the classpath).",
  322. "platforms": ["js", "lua"],
  323. "params": ["name"],
  324. "links": ["https://haxe.org/manual/target-javascript-expose.html"]
  325. },
  326. {
  327. "name": "Extern",
  328. "metadata": ":extern",
  329. "doc": "Marks the field as extern so it is not generated.",
  330. "targets": ["TClassField"]
  331. },
  332. {
  333. "name": "File",
  334. "metadata": ":file",
  335. "doc": "Includes a given binary file into the target SWF and associates it with the class (must extend `flash.utils.ByteArray`).",
  336. "platforms": ["flash"],
  337. "params": ["File path"],
  338. "targets": ["TClass"],
  339. "links": ["https://haxe.org/manual/target-flash-resources.html"]
  340. },
  341. {
  342. "name": "FileXml",
  343. "metadata": ":fileXml",
  344. "doc": "Include a given XML attribute snippet in the `Build.xml` entry for the file.",
  345. "platforms": ["cpp"],
  346. "targets": ["TClass"]
  347. },
  348. {
  349. "name": "Final",
  350. "metadata": ":final",
  351. "doc": "Prevents a class or interface from being extended or a method from being overridden. Deprecated by the keyword `final`.",
  352. "targets": ["TClass", "TClassField"],
  353. "links": ["https://haxe.org/manual/class-field-final.html"]
  354. },
  355. {
  356. "devcomment": "this used to have UsedOn TObjectDecl(_)",
  357. "name": "Fixed",
  358. "metadata": ":fixed",
  359. "doc": "Declares an anonymous object to have fixed fields."
  360. },
  361. {
  362. "name": "FlashProperty",
  363. "metadata": ":flash.property",
  364. "doc": "",
  365. "platforms": ["flash"],
  366. "targets": ["TClassField"]
  367. },
  368. {
  369. "name": "FlatEnum",
  370. "metadata": ":flatEnum",
  371. "doc": "Internally used to mark an enum as being flat, i.e. having no function constructors.",
  372. "targets": ["TEnum"],
  373. "internal": true
  374. },
  375. {
  376. "name": "Font",
  377. "metadata": ":font",
  378. "doc": "Embeds the given TrueType font into the class (must extend `flash.text.Font`).",
  379. "params": ["TTF path", "Range String"],
  380. "targets": ["TClass"],
  381. "links": ["https://haxe.org/manual/target-flash-resources.html"]
  382. },
  383. {
  384. "name": "ForLoopVariable",
  385. "metadata": ":forLoopVariable",
  386. "doc": "Internally used to mark for-loop variables.",
  387. "internal": true
  388. },
  389. {
  390. "name": "Forward",
  391. "metadata": ":forward",
  392. "doc": "Forwards field access to underlying type.",
  393. "params": ["List of field names"],
  394. "targets": ["TAbstract"],
  395. "links": ["https://haxe.org/manual/types-abstract-forward.html"]
  396. },
  397. {
  398. "name": "ForwardNew",
  399. "metadata": ":forward.new",
  400. "doc": "Forwards constructor call to underlying type.",
  401. "targets": ["TAbstract"]
  402. },
  403. {
  404. "name": "ForwardStatics",
  405. "metadata": ":forwardStatics",
  406. "doc": "Forwards static field access to underlying type.",
  407. "params": ["List of field names"],
  408. "targets": ["TAbstract"],
  409. "links": ["https://haxe.org/manual/types-abstract-forward.html"]
  410. },
  411. {
  412. "name": "ForwardVariance",
  413. "metadata": ":forward.variance",
  414. "doc": "Forwards variance unification to underlying type.",
  415. "targets": ["TAbstract"]
  416. },
  417. {
  418. "name": "From",
  419. "metadata": ":from",
  420. "doc": "Specifies that the field of the abstract is a cast operation from the type identified in the function.",
  421. "targets": ["TAbstractField"],
  422. "links": ["https://haxe.org/manual/types-abstract-implicit-casts.html"]
  423. },
  424. {
  425. "name": "FunctionCode",
  426. "metadata": ":functionCode",
  427. "doc": "Used to inject platform-native code into a function.",
  428. "platforms": ["cpp", "java", "cs"]
  429. },
  430. {
  431. "name": "FunctionTailCode",
  432. "metadata": ":functionTailCode",
  433. "doc": "",
  434. "platforms": ["cpp"]
  435. },
  436. {
  437. "name": "Generic",
  438. "metadata": ":generic",
  439. "doc": "Marks a class or class field as generic so each type parameter combination generates its own type/field.",
  440. "links": ["https://haxe.org/manual/type-system-generic.html"]
  441. },
  442. {
  443. "name": "GenericBuild",
  444. "metadata": ":genericBuild",
  445. "doc": "Builds instances of a type using the specified macro.",
  446. "targets": ["TClass"]
  447. },
  448. {
  449. "name": "GenericInstance",
  450. "metadata": ":genericInstance",
  451. "doc": "Internally used to mark instances of `@:generic` methods.",
  452. "targets": ["TClassField"],
  453. "internal": true
  454. },
  455. {
  456. "name": "GenericClassPerMethod",
  457. "metadata": ":genericClassPerMethod",
  458. "doc": "Makes compiler generate separate class per generic static method specialization",
  459. "targets": ["TClass"]
  460. },
  461. {
  462. "name": "Getter",
  463. "metadata": ":getter",
  464. "doc": "Generates a native getter function on the given field.",
  465. "platforms": ["flash"],
  466. "params": ["Class field name"],
  467. "targets": ["TClassField"]
  468. },
  469. {
  470. "name": "Hack",
  471. "metadata": ":hack",
  472. "doc": "Allows extending classes marked as `@:final`. Not guaranteed to work on all targets.",
  473. "targets": ["TClass"]
  474. },
  475. {
  476. "name": "HasUntyped",
  477. "metadata": ":has_untyped",
  478. "doc": "Used by the typer to mark fields that have untyped expressions.",
  479. "internal": true
  480. },
  481. {
  482. "name": "HaxeGeneric",
  483. "metadata": ":haxeGeneric",
  484. "doc": "Used internally to annotate non-native generic classes.",
  485. "platforms": ["cs"],
  486. "targets": ["TClass", "TEnum"],
  487. "internal": true
  488. },
  489. {
  490. "name": "HeaderClassCode",
  491. "metadata": ":headerClassCode",
  492. "doc": "Code to be injected into the generated class, in the header.",
  493. "platforms": ["cpp"]
  494. },
  495. {
  496. "name": "HeaderCode",
  497. "metadata": ":headerCode",
  498. "doc": "Code to be injected into the generated header file.",
  499. "platforms": ["cpp"]
  500. },
  501. {
  502. "name": "HeaderInclude",
  503. "metadata": ":headerInclude",
  504. "doc": "File to be included in generated header file.",
  505. "platforms": ["cpp"]
  506. },
  507. {
  508. "name": "HeaderNamespaceCode",
  509. "metadata": ":headerNamespaceCode",
  510. "doc": "",
  511. "platforms": ["cpp"]
  512. },
  513. {
  514. "name": "HlNative",
  515. "metadata": ":hlNative",
  516. "doc": "Specifies `hdll` name and function prefix for native functions.",
  517. "platforms": ["hl"],
  518. "targets": ["TClass", "TClassField"]
  519. },
  520. {
  521. "name": "HxGen",
  522. "metadata": ":hxGen",
  523. "doc": "Annotates that an extern class was generated by Haxe.",
  524. "platforms": ["java", "cs"],
  525. "targets": ["TClass", "TEnum"]
  526. },
  527. {
  528. "name": "IfFeature",
  529. "metadata": ":ifFeature",
  530. "doc": "Causes a field to be kept by DCE if the given feature is part of the compilation.",
  531. "params": ["Feature name"],
  532. "targets": ["TClassField"],
  533. "links": ["https://haxe.org/manual/cr-dce.html"]
  534. },
  535. {
  536. "name": "PythonImport",
  537. "metadata": ":pythonImport",
  538. "doc": "Generates python import statement for extern classes.",
  539. "platforms": ["python"],
  540. "targets": ["TClass"]
  541. },
  542. {
  543. "name": "ImplicitCast",
  544. "metadata": ":implicitCast",
  545. "doc": "Generated automatically on the AST when an implicit abstract cast happens.",
  546. "targets": ["TExpr"],
  547. "internal": true
  548. },
  549. {
  550. "name": "ImplicitReturn",
  551. "metadata": ":implicitReturn",
  552. "doc": "Generated automatically on the AST when an implicit return is inserted for arrow function.",
  553. "targets": ["TExpr"],
  554. "internal": true
  555. },
  556. {
  557. "name": "Include",
  558. "metadata": ":include",
  559. "doc": "",
  560. "platforms": ["cpp"]
  561. },
  562. {
  563. "name": "InitPackage",
  564. "metadata": ":initPackage",
  565. "doc": "Some weird thing for Genjs we want to remove someday.",
  566. "platforms": ["js"],
  567. "internal": true
  568. },
  569. {
  570. "name": "Inline",
  571. "metadata": ":inline",
  572. "doc": "Inserted by the parser in case of `inline expr` and `inline function`.",
  573. "targets": ["TExpr"]
  574. },
  575. {
  576. "name": "InlineConstructorArgument",
  577. "metadata": ":inlineConstructorArgument",
  578. "doc": "Internally used to mark expressions that were passed as arguments of an inlined constructor.",
  579. "internal": true
  580. },
  581. {
  582. "name": "InlineObject",
  583. "metadata": ":inlineObject",
  584. "doc": "Internally used by inline constructors filter to mark potentially inlineable objects.",
  585. "internal": true
  586. },
  587. {
  588. "name": "Internal",
  589. "metadata": ":internal",
  590. "doc": "Generates the annotated field/class with 'internal' access.",
  591. "platforms": ["java", "cs"],
  592. "targets": ["TClass", "TEnum", "TClassField"]
  593. },
  594. {
  595. "name": "IsVar",
  596. "metadata": ":isVar",
  597. "doc": "Forces a physical field to be generated for properties that otherwise would not require one.",
  598. "targets": ["TClassField"],
  599. "links": ["https://haxe.org/manual/class-field-property-rules.html"]
  600. },
  601. {
  602. "name": "JavaCanonical",
  603. "metadata": ":javaCanonical",
  604. "doc": "Used by the Java target to annotate the canonical path of the type.",
  605. "platforms": ["java"],
  606. "params": ["Output type package", "Output type name"],
  607. "targets": ["TClass", "TEnum"]
  608. },
  609. {
  610. "name": "JavaNative",
  611. "metadata": ":javaNative",
  612. "doc": "Automatically added by `--java-lib` on classes generated from JAR/class files.",
  613. "platforms": ["java"],
  614. "targets": ["TClass", "TEnum"],
  615. "internal": true
  616. },
  617. {
  618. "name": "JvmSynthetic",
  619. "metadata": ":jvm.synthetic",
  620. "doc": "Mark generated class, field or method as synthetic",
  621. "platforms": ["java"],
  622. "targets": ["TClass", "TEnum", "TAnyField"]
  623. },
  624. {
  625. "name": "JsRequire",
  626. "metadata": ":jsRequire",
  627. "doc": "Generate JavaScript module require expression for given extern.",
  628. "platforms": ["js"],
  629. "targets": ["TClass"],
  630. "links": ["https://haxe.org/manual/target-javascript-require.html"]
  631. },
  632. {
  633. "name": "LuaRequire",
  634. "metadata": ":luaRequire",
  635. "doc": "Generate Lua module require expression for given extern.",
  636. "platforms": ["lua"],
  637. "targets": ["TClass"]
  638. },
  639. {
  640. "name": "LuaDotMethod",
  641. "metadata": ":luaDotMethod",
  642. "doc": "Indicates that the given extern type instance should have dot-style invocation for methods instead of colon.",
  643. "platforms": ["lua"]
  644. },
  645. {
  646. "name": "Keep",
  647. "metadata": ":keep",
  648. "doc": "Causes a field or type to be kept by DCE.",
  649. "links": ["https://haxe.org/manual/cr-dce.html"]
  650. },
  651. {
  652. "name": "KeepInit",
  653. "metadata": ":keepInit",
  654. "doc": "Causes a class to be kept by DCE even if all its field are removed.",
  655. "targets": ["TClass"],
  656. "links": ["https://haxe.org/manual/cr-dce.html"]
  657. },
  658. {
  659. "name": "KeepSub",
  660. "metadata": ":keepSub",
  661. "doc": "Extends `@:keep` metadata to all implementing and extending classes.",
  662. "targets": ["TClass"],
  663. "links": ["https://haxe.org/manual/cr-dce.html"]
  664. },
  665. {
  666. "name": "LibType",
  667. "metadata": ":libType",
  668. "doc": "Used by `--net-lib` and `--java-lib` to mark a class that should not be checked (overrides, interfaces, etc) by the type loader.",
  669. "platforms": ["java", "cs"],
  670. "targets": ["TClass"],
  671. "internal": true
  672. },
  673. {
  674. "name": "LoopLabel",
  675. "metadata": ":loopLabel",
  676. "doc": "Mark loop and break expressions with a label to support breaking from within switch.",
  677. "internal": true
  678. },
  679. {
  680. "name": "Markup",
  681. "metadata": ":markup",
  682. "doc": "Used as a result of inline XML parsing.",
  683. "links": ["https://haxe.org/manual/lf-markup.html"]
  684. },
  685. {
  686. "name": "Meta",
  687. "metadata": ":meta",
  688. "doc": "Internally used to mark a class field as being the metadata field.",
  689. "internal": true
  690. },
  691. {
  692. "name": "Macro",
  693. "metadata": ":macro",
  694. "doc": "(deprecated)"
  695. },
  696. {
  697. "name": "MaybeUsed",
  698. "metadata": ":maybeUsed",
  699. "doc": "Internally used by DCE to mark fields that might be kept.",
  700. "internal": true
  701. },
  702. {
  703. "name": "MergeBlock",
  704. "metadata": ":mergeBlock",
  705. "doc": "Merge the annotated block into the current scope.",
  706. "targets": ["TExpr"]
  707. },
  708. {
  709. "name": "MultiReturn",
  710. "metadata": ":multiReturn",
  711. "doc": "Annotates an extern class as the result of multi-return function.",
  712. "platforms": ["lua"],
  713. "targets": ["TClass"],
  714. "links": ["https://haxe.org/manual/target-lua-multireturns.html"]
  715. },
  716. {
  717. "name": "MultiType",
  718. "metadata": ":multiType",
  719. "doc": "Specifies that an abstract chooses its this-type from its `@:to` functions.",
  720. "params": ["Relevant type parameters"],
  721. "targets": ["TAbstract"]
  722. },
  723. {
  724. "name": "Native",
  725. "metadata": ":native",
  726. "doc": "Rewrites the path of a type or class field during generation.",
  727. "params": ["Output path"],
  728. "targets": ["TClass", "TEnum", "TAbstract", "TClassField"],
  729. "links": ["https://haxe.org/manual/lf-externs.html"]
  730. },
  731. {
  732. "name": "NativeJni",
  733. "metadata": ":java.native",
  734. "doc": "Annotates that a function has implementation in native code through JNI.",
  735. "platforms": ["java"],
  736. "targets": ["TClassField"]
  737. },
  738. {
  739. "name": "NativeChildren",
  740. "metadata": ":nativeChildren",
  741. "doc": "Annotates that all children from a type should be treated as if it were an extern definition - platform native.",
  742. "platforms": ["java", "cs"],
  743. "targets": ["TClass"]
  744. },
  745. {
  746. "name": "NativeGen",
  747. "metadata": ":nativeGen",
  748. "doc": "Annotates that a type should be treated as if it were an extern definition - platform native.",
  749. "platforms": ["java", "cs", "python"],
  750. "targets": ["TClass", "TEnum"]
  751. },
  752. {
  753. "name": "NativeGeneric",
  754. "metadata": ":nativeGeneric",
  755. "doc": "Used internally to annotate native generic classes.",
  756. "platforms": ["cs"],
  757. "targets": ["TClass", "TEnum"],
  758. "internal": true
  759. },
  760. {
  761. "name": "NativeProperty",
  762. "metadata": ":nativeProperty",
  763. "doc": "Use native properties which will execute even with dynamic usage.",
  764. "platforms": ["cpp"]
  765. },
  766. {
  767. "name": "NativeStaticExtension",
  768. "metadata": ":nativeStaticExtension",
  769. "doc": "Converts static function syntax into member call.",
  770. "platforms": ["cpp"]
  771. },
  772. {
  773. "name": "NoCompletion",
  774. "metadata": ":noCompletion",
  775. "doc": "Prevents the compiler from suggesting completion on this field or type.",
  776. "targets": ["TClassField"],
  777. "links": ["https://haxe.org/manual/cr-completion.html"]
  778. },
  779. {
  780. "name": "NoClosure",
  781. "metadata": ":noClosure",
  782. "doc": "Prevents a method or all methods in a class from being used as a value.",
  783. "targets": ["TClass", "TClassField"]
  784. },
  785. {
  786. "name": "NoDebug",
  787. "metadata": ":noDebug",
  788. "doc": "Does not generate debug information even if `--debug` is set.",
  789. "platforms": ["flash", "cpp"],
  790. "targets": ["TClass", "TClassField"]
  791. },
  792. {
  793. "name": "NoDoc",
  794. "metadata": ":noDoc",
  795. "doc": "Prevents a type from being included in documentation generation."
  796. },
  797. {
  798. "name": "NoExpr",
  799. "metadata": ":noExpr",
  800. "doc": "Internally used to mark abstract fields which have no expression by design.",
  801. "internal": true
  802. },
  803. {
  804. "name": "NoImportGlobal",
  805. "metadata": ":noImportGlobal",
  806. "doc": "Prevents a static field from being imported with `import Class.*`.",
  807. "targets": ["TAnyField"]
  808. },
  809. {
  810. "name": "NonVirtual",
  811. "metadata": ":nonVirtual",
  812. "doc": "Declares function to be non-virtual in cpp.",
  813. "platforms": ["cpp"]
  814. },
  815. {
  816. "name": "NoPackageRestrict",
  817. "metadata": ":noPackageRestrict",
  818. "doc": "Allows a module to be accessed across all targets if found on its first type.",
  819. "internal": true
  820. },
  821. {
  822. "name": "NoPrivateAccess",
  823. "metadata": ":noPrivateAccess",
  824. "doc": "Disallow private access to anything for the annotated expression.",
  825. "targets": ["TExpr"]
  826. },
  827. {
  828. "name": "NoStack",
  829. "metadata": ":noStack",
  830. "doc": "",
  831. "platforms": ["cpp"]
  832. },
  833. {
  834. "name": "NotNull",
  835. "metadata": ":notNull",
  836. "doc": "Declares an abstract type as not accepting null values.",
  837. "targets": ["TAbstract"],
  838. "links": ["https://haxe.org/manual/types-nullability.html"]
  839. },
  840. {
  841. "name": "NoUsing",
  842. "metadata": ":noUsing",
  843. "doc": "Prevents a field from being used with static extension.",
  844. "targets": ["TClassField"],
  845. "links": ["https://haxe.org/manual/lf-static-extension.html"]
  846. },
  847. {
  848. "name": "Ns",
  849. "metadata": ":ns",
  850. "doc": "Internally used by the SWF generator to handle namespaces.",
  851. "platforms": ["flash"],
  852. "internal": true
  853. },
  854. {
  855. "name": "NullSafety",
  856. "metadata": ":nullSafety",
  857. "doc": "Enables null safety for classes or fields. Disables null safety for classes, fields or expressions if provided with `Off` as an argument.",
  858. "params": ["Off | Loose | Strict | StrictThreaded"],
  859. "targets": ["TClass", "TClassField", "TExpr"],
  860. "links": ["https://haxe.org/manual/cr-null-safety.html"]
  861. },
  862. {
  863. "name": "Objc",
  864. "metadata": ":objc",
  865. "doc": "Declares a class or interface that is used to interoperate with Objective-C code.",
  866. "platforms": ["cpp"],
  867. "targets": ["TClass"]
  868. },
  869. {
  870. "name": "ObjcProtocol",
  871. "metadata": ":objcProtocol",
  872. "doc": "Associates an interface with, or describes a function in, a native Objective-C protocol.",
  873. "platforms": ["cpp"]
  874. },
  875. {
  876. "name": "Op",
  877. "metadata": ":op",
  878. "doc": "Declares an abstract field as being an operator overload.",
  879. "params": ["The operation"],
  880. "targets": ["TAbstractField"],
  881. "links": ["https://haxe.org/manual/types-abstract-operator-overloading.html"]
  882. },
  883. {
  884. "name": "Optional",
  885. "metadata": ":optional",
  886. "doc": "Marks the field of a structure as optional.",
  887. "targets": ["TClassField"],
  888. "links": ["https://haxe.org/manual/types-nullability-optional-arguments.html"]
  889. },
  890. {
  891. "name": "Overload",
  892. "metadata": ":overload",
  893. "doc": "Allows the field to be called with different argument types.",
  894. "params": ["Function specification (no expression)"],
  895. "targets": ["TClassField"],
  896. "links": ["https://haxe.org/manual/target-javascript-external-libraries.html"]
  897. },
  898. {
  899. "name": "Persistent",
  900. "metadata": ":persistent",
  901. "doc": "Keeps the value of static variables in macro context across compilations.",
  902. "targets": ["TAnyField"],
  903. "platforms": ["eval"]
  904. },
  905. {
  906. "name": "PhpGlobal",
  907. "metadata": ":phpGlobal",
  908. "doc": "Indicates that static fields of an extern class actually are located in the global PHP namespace.",
  909. "platforms": ["php"],
  910. "targets": ["TClass"]
  911. },
  912. {
  913. "name": "PhpClassConst",
  914. "metadata": ":phpClassConst",
  915. "doc": "Indicates that a static var of an extern class is a PHP class constant.",
  916. "platforms": ["php"],
  917. "targets": ["TClassField"]
  918. },
  919. {
  920. "name": "PhpMagic",
  921. "metadata": ":phpMagic",
  922. "doc": "Treat annotated field as special PHP magic field - this meta makes compiler avoid renaming such fields on generating PHP code.",
  923. "platforms": ["php"],
  924. "targets": ["TClassField"]
  925. },
  926. {
  927. "name": "PhpNoConstructor",
  928. "metadata": ":phpNoConstructor",
  929. "doc": "Special meta for extern classes which do not have native constructor in PHP, but need a constructor in Haxe extern.",
  930. "platforms": ["php"],
  931. "targets": ["TClass"]
  932. },
  933. {
  934. "name": "Pos",
  935. "metadata": ":pos",
  936. "doc": "Sets the position of a reified expression.",
  937. "params": ["Position"],
  938. "targets": ["TExpr"],
  939. "links": ["https://haxe.org/manual/macro-reification.html"]
  940. },
  941. {
  942. "name": "Public",
  943. "metadata": ":public",
  944. "doc": "Marks a class field as being public.",
  945. "targets": ["TClassField"],
  946. "internal": true
  947. },
  948. {
  949. "name": "PublicFields",
  950. "metadata": ":publicFields",
  951. "doc": "Forces all class fields of inheriting classes to be public.",
  952. "targets": ["TClass"]
  953. },
  954. {
  955. "name": "Private",
  956. "metadata": ":private",
  957. "doc": "Marks a class field as being private.",
  958. "platforms": ["cs"],
  959. "targets": ["TClassField"]
  960. },
  961. {
  962. "name": "PrivateAccess",
  963. "metadata": ":privateAccess",
  964. "doc": "Allow private access to anything for the annotated expression.",
  965. "targets": ["TExpr"]
  966. },
  967. {
  968. "name": "Protected",
  969. "metadata": ":protected",
  970. "doc": "Marks a class field as being protected.",
  971. "platforms": ["cs", "java", "flash"],
  972. "targets": ["TClassField"]
  973. },
  974. {
  975. "name": "Property",
  976. "metadata": ":property",
  977. "doc": "Marks a field to be compiled as a native C# property.",
  978. "platforms": ["cs"],
  979. "targets": ["TClassField"]
  980. },
  981. {
  982. "name": "Pure",
  983. "metadata": ":pure",
  984. "doc": "Marks a class field, class or expression as pure (side-effect free).",
  985. "targets": ["TClass", "TClassField", "TExpr"]
  986. },
  987. {
  988. "name": "ReadOnly",
  989. "metadata": ":readOnly",
  990. "doc": "Generates a field with the `readonly` native keyword.",
  991. "platforms": ["cs"],
  992. "targets": ["TClassField"]
  993. },
  994. {
  995. "name": "RealPath",
  996. "metadata": ":realPath",
  997. "doc": "Internally used on `@:native` types to retain original path information.",
  998. "internal": true
  999. },
  1000. {
  1001. "name": "Remove",
  1002. "metadata": ":remove",
  1003. "doc": "Causes an interface to be removed from all implementing classes before generation.",
  1004. "targets": ["TClass"]
  1005. },
  1006. {
  1007. "name": "Require",
  1008. "metadata": ":require",
  1009. "doc": "Allows access to a field only if the specified compiler flag is set.",
  1010. "params": ["Compiler flag to check"],
  1011. "targets": ["TClassField"],
  1012. "links": ["https://haxe.org/manual/lf-condition-compilation.html"]
  1013. },
  1014. {
  1015. "name": "Resolve",
  1016. "metadata": ":resolve",
  1017. "doc": "Abstract fields marked with this metadata can be used to resolve unknown fields.",
  1018. "targets": ["TClassField"]
  1019. },
  1020. {
  1021. "name": "Rtti",
  1022. "metadata": ":rtti",
  1023. "doc": "Adds runtime type information.",
  1024. "targets": ["TClass"],
  1025. "links": ["https://haxe.org/manual/cr-rtti.html"]
  1026. },
  1027. {
  1028. "name": "Runtime",
  1029. "metadata": ":runtime",
  1030. "doc": "",
  1031. "internal": true
  1032. },
  1033. {
  1034. "name": "RuntimeValue",
  1035. "metadata": ":runtimeValue",
  1036. "doc": "Marks an abstract as being a runtime value.",
  1037. "targets": ["TAbstract"]
  1038. },
  1039. {
  1040. "name": "Scalar",
  1041. "metadata": ":scalar",
  1042. "doc": "Used by hxcpp to mark a custom coreType abstract.",
  1043. "platforms": ["cpp"],
  1044. "targets": ["TAbstract"]
  1045. },
  1046. {
  1047. "name": "SelfCall",
  1048. "metadata": ":selfCall",
  1049. "doc": "Translates method calls into calling object directly.",
  1050. "platforms": ["js", "lua"],
  1051. "targets": ["TClassField"],
  1052. "links": ["https://haxe.org/manual/target-javascript-external-libraries.html"]
  1053. },
  1054. {
  1055. "name": "Semantics",
  1056. "metadata": ":semantics",
  1057. "doc": "The native semantics of the type.",
  1058. "params": ["value | reference | variable"],
  1059. "targets": ["TClass", "TTypedef", "TAbstract"]
  1060. },
  1061. {
  1062. "name": "Setter",
  1063. "metadata": ":setter",
  1064. "doc": "Generates a native setter function on the given field.",
  1065. "platforms": ["flash"],
  1066. "params": ["Class field name"],
  1067. "targets": ["TClassField"]
  1068. },
  1069. {
  1070. "name": "SkipCtor",
  1071. "metadata": ":skipCtor",
  1072. "doc": "Used internally to generate a constructor as if it were a native type (no `__hx_ctor`).",
  1073. "platforms": ["java", "cs"],
  1074. "internal": true
  1075. },
  1076. {
  1077. "name": "SkipReflection",
  1078. "metadata": ":skipReflection",
  1079. "doc": "Used internally to annotate a field that shouldn't have its reflection data generated.",
  1080. "platforms": ["java", "cs"],
  1081. "targets": ["TClassField"],
  1082. "internal": true
  1083. },
  1084. {
  1085. "name": "Sound",
  1086. "metadata": ":sound",
  1087. "doc": "Includes a given .wav or .mp3 file into the target SWF and associates it with the class (must extend `flash.media.Sound`).",
  1088. "platforms": ["flash"],
  1089. "params": ["File path"],
  1090. "targets": ["TClass"],
  1091. "links": ["https://haxe.org/manual/target-flash-resources.html"]
  1092. },
  1093. {
  1094. "name": "SourceFile",
  1095. "metadata": ":sourceFile",
  1096. "doc": "Source code filename for external class.",
  1097. "platforms": ["cpp"]
  1098. },
  1099. {
  1100. "name": "StackOnly",
  1101. "metadata": ":stackOnly",
  1102. "doc": "Instances of this type can only appear on the stack.",
  1103. "platforms": ["cpp"]
  1104. },
  1105. {
  1106. "name": "StaticExtension",
  1107. "metadata": "haxe.internal.static_extension",
  1108. "doc": "Used internally to mark static extension fields.",
  1109. "internal": true
  1110. },
  1111. {
  1112. "name": "StoredTypedExpr",
  1113. "metadata": ":storedTypedExpr",
  1114. "doc": "Used internally to reference a typed expression returned from a macro.",
  1115. "internal": true
  1116. },
  1117. {
  1118. "name": "Strict",
  1119. "metadata": ":strict",
  1120. "doc": "Used to declare a native C# attribute or a native Java metadata; is type checked.",
  1121. "platforms": ["java", "cs"]
  1122. },
  1123. {
  1124. "name": "Struct",
  1125. "metadata": ":struct",
  1126. "doc": "Marks a class definition as a struct.",
  1127. "platforms": ["cs", "hl"],
  1128. "targets": ["TClass"]
  1129. },
  1130. {
  1131. "name": "StructAccess",
  1132. "metadata": ":structAccess",
  1133. "doc": "Marks an extern class as using struct access (`.`) not pointer (`->`).",
  1134. "platforms": ["cpp"],
  1135. "targets": ["TClass"]
  1136. },
  1137. {
  1138. "name": "StructInit",
  1139. "metadata": ":structInit",
  1140. "doc": "Allows one to initialize the class with a structure that matches constructor parameters.",
  1141. "targets": ["TClass"]
  1142. },
  1143. {
  1144. "name": "SuppressWarnings",
  1145. "metadata": ":suppressWarnings",
  1146. "doc": "Adds a `SuppressWarnings` annotation for the generated Java class.",
  1147. "platforms": ["java"],
  1148. "targets": ["TClass"]
  1149. },
  1150. {
  1151. "name": "TailRecursion",
  1152. "metadata": ":tailRecursion",
  1153. "doc": "Internally used for tail recursion elimination.",
  1154. "internal": true
  1155. },
  1156. {
  1157. "name": "TemplatedCall",
  1158. "metadata": ":templatedCall",
  1159. "doc": "Indicates that the first parameter of static call should be treated as a template argument.",
  1160. "platforms": ["cpp"],
  1161. "targets": ["TClassField"]
  1162. },
  1163. {
  1164. "name": "Throws",
  1165. "metadata": ":throws",
  1166. "doc": "Adds a `throws` declaration to the generated function.",
  1167. "platforms": ["java"],
  1168. "params": ["Type as String"],
  1169. "targets": ["TClassField"]
  1170. },
  1171. {
  1172. "name": "This",
  1173. "metadata": ":this",
  1174. "doc": "Internally used to pass a `this` expression to macros.",
  1175. "targets": ["TExpr"],
  1176. "internal": true
  1177. },
  1178. {
  1179. "name": "To",
  1180. "metadata": ":to",
  1181. "doc": "Specifies that the field of the abstract is a cast operation to the type identified in the function.",
  1182. "targets": ["TAbstractField"],
  1183. "links": ["https://haxe.org/manual/types-abstract-implicit-casts.html"]
  1184. },
  1185. {
  1186. "name": "ToString",
  1187. "metadata": ":toString",
  1188. "doc": "Internally used.",
  1189. "internal": true
  1190. },
  1191. {
  1192. "name": "Transient",
  1193. "metadata": ":transient",
  1194. "doc": "Adds the `transient` flag to the class field.",
  1195. "platforms": ["java"],
  1196. "targets": ["TClassField"]
  1197. },
  1198. {
  1199. "name": "Transitive",
  1200. "metadata": ":transitive",
  1201. "doc": "Allows transitive casts with an abstract.",
  1202. "targets": ["TAbstract"]
  1203. },
  1204. {
  1205. "name": "ValueUsed",
  1206. "metadata": ":valueUsed",
  1207. "doc": "Internally used by DCE to mark an abstract value as used.",
  1208. "internal": true
  1209. },
  1210. {
  1211. "name": "Volatile",
  1212. "metadata": ":volatile",
  1213. "doc": "",
  1214. "platforms": ["java", "cs"]
  1215. },
  1216. {
  1217. "name": "UnifyMinDynamic",
  1218. "metadata": ":unifyMinDynamic",
  1219. "doc": "Allows a collection of types to unify to `Dynamic`.",
  1220. "targets": ["TClassField"]
  1221. },
  1222. {
  1223. "name": "Unreflective",
  1224. "metadata": ":unreflective",
  1225. "doc": "",
  1226. "platforms": ["cpp"]
  1227. },
  1228. {
  1229. "name": "Unsafe",
  1230. "metadata": ":unsafe",
  1231. "doc": "Declares a class, or a method with the C#'s `unsafe` flag.",
  1232. "platforms": ["cs"],
  1233. "targets": ["TClass", "TClassField"]
  1234. },
  1235. {
  1236. "name": "Used",
  1237. "metadata": ":used",
  1238. "doc": "Internally used by DCE to mark a class or field as used.",
  1239. "internal": true
  1240. },
  1241. {
  1242. "name": "Using",
  1243. "metadata": ":using",
  1244. "doc": "Automatically uses the argument types as static extensions for the annotated type.",
  1245. "targets": ["TClass", "TEnum", "TAbstract"],
  1246. "links": ["https://haxe.org/manual/lf-static-extension-metadata.html"]
  1247. },
  1248. {
  1249. "name": "Value",
  1250. "metadata": ":value",
  1251. "doc": "Used to store default values for fields and function arguments.",
  1252. "targets": ["TClassField"],
  1253. "internal": true
  1254. },
  1255. {
  1256. "name": "HaxeArguments",
  1257. "metadata": ":haxe.arguments",
  1258. "doc": "Used to store function arguments.",
  1259. "targets": ["TClassField"],
  1260. "internal": true
  1261. },
  1262. {
  1263. "name": "Void",
  1264. "metadata": ":void",
  1265. "doc": "Use Cpp native `void` return type.",
  1266. "platforms": ["cpp"]
  1267. },
  1268. {
  1269. "name": "NeedsExceptionStack",
  1270. "metadata": ":needsExceptionStack",
  1271. "doc": "Internally used for some of auto-generated `catch` vars",
  1272. "internal": true
  1273. }
  1274. ]