meta.json 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263
  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": "ForwardStatics",
  399. "metadata": ":forwardStatics",
  400. "doc": "Forwards static field access to underlying type.",
  401. "params": ["List of field names"],
  402. "targets": ["TAbstract"],
  403. "links": ["https://haxe.org/manual/types-abstract-forward.html"]
  404. },
  405. {
  406. "name": "From",
  407. "metadata": ":from",
  408. "doc": "Specifies that the field of the abstract is a cast operation from the type identified in the function.",
  409. "targets": ["TAbstractField"],
  410. "links": ["https://haxe.org/manual/types-abstract-implicit-casts.html"]
  411. },
  412. {
  413. "name": "FunctionCode",
  414. "metadata": ":functionCode",
  415. "doc": "Used to inject platform-native code into a function.",
  416. "platforms": ["cpp", "java", "cs"]
  417. },
  418. {
  419. "name": "FunctionTailCode",
  420. "metadata": ":functionTailCode",
  421. "doc": "",
  422. "platforms": ["cpp"]
  423. },
  424. {
  425. "name": "Generic",
  426. "metadata": ":generic",
  427. "doc": "Marks a class or class field as generic so each type parameter combination generates its own type/field.",
  428. "links": ["https://haxe.org/manual/type-system-generic.html"]
  429. },
  430. {
  431. "name": "GenericBuild",
  432. "metadata": ":genericBuild",
  433. "doc": "Builds instances of a type using the specified macro.",
  434. "targets": ["TClass"]
  435. },
  436. {
  437. "name": "GenericInstance",
  438. "metadata": ":genericInstance",
  439. "doc": "Internally used to mark instances of `@:generic` methods.",
  440. "targets": ["TClassField"],
  441. "internal": true
  442. },
  443. {
  444. "name": "GenericClassPerMethod",
  445. "metadata": ":genericClassPerMethod",
  446. "doc": "Makes compiler generate separate class per generic static method specialization",
  447. "targets": ["TClass"]
  448. },
  449. {
  450. "name": "Getter",
  451. "metadata": ":getter",
  452. "doc": "Generates a native getter function on the given field.",
  453. "platforms": ["flash"],
  454. "params": ["Class field name"],
  455. "targets": ["TClassField"]
  456. },
  457. {
  458. "name": "Hack",
  459. "metadata": ":hack",
  460. "doc": "Allows extending classes marked as `@:final`. Not guaranteed to work on all targets.",
  461. "targets": ["TClass"]
  462. },
  463. {
  464. "name": "HasUntyped",
  465. "metadata": ":has_untyped",
  466. "doc": "Used by the typer to mark fields that have untyped expressions.",
  467. "internal": true
  468. },
  469. {
  470. "name": "HaxeGeneric",
  471. "metadata": ":haxeGeneric",
  472. "doc": "Used internally to annotate non-native generic classes.",
  473. "platforms": ["cs"],
  474. "targets": ["TClass", "TEnum"],
  475. "internal": true
  476. },
  477. {
  478. "name": "HeaderClassCode",
  479. "metadata": ":headerClassCode",
  480. "doc": "Code to be injected into the generated class, in the header.",
  481. "platforms": ["cpp"]
  482. },
  483. {
  484. "name": "HeaderCode",
  485. "metadata": ":headerCode",
  486. "doc": "Code to be injected into the generated header file.",
  487. "platforms": ["cpp"]
  488. },
  489. {
  490. "name": "HeaderInclude",
  491. "metadata": ":headerInclude",
  492. "doc": "File to be included in generated header file.",
  493. "platforms": ["cpp"]
  494. },
  495. {
  496. "name": "HeaderNamespaceCode",
  497. "metadata": ":headerNamespaceCode",
  498. "doc": "",
  499. "platforms": ["cpp"]
  500. },
  501. {
  502. "name": "HlNative",
  503. "metadata": ":hlNative",
  504. "doc": "Specifies `hdll` name and function prefix for native functions.",
  505. "platforms": ["hl"],
  506. "targets": ["TClass", "TClassField"]
  507. },
  508. {
  509. "name": "HxGen",
  510. "metadata": ":hxGen",
  511. "doc": "Annotates that an extern class was generated by Haxe.",
  512. "platforms": ["java", "cs"],
  513. "targets": ["TClass", "TEnum"]
  514. },
  515. {
  516. "name": "IfFeature",
  517. "metadata": ":ifFeature",
  518. "doc": "Causes a field to be kept by DCE if the given feature is part of the compilation.",
  519. "params": ["Feature name"],
  520. "targets": ["TClassField"],
  521. "links": ["https://haxe.org/manual/cr-dce.html"]
  522. },
  523. {
  524. "name": "Impl",
  525. "metadata": ":impl",
  526. "doc": "Used internally to mark abstract implementation fields.",
  527. "targets": ["TAbstractField"],
  528. "internal": true
  529. },
  530. {
  531. "name": "PythonImport",
  532. "metadata": ":pythonImport",
  533. "doc": "Generates python import statement for extern classes.",
  534. "platforms": ["python"],
  535. "targets": ["TClass"]
  536. },
  537. {
  538. "name": "ImplicitCast",
  539. "metadata": ":implicitCast",
  540. "doc": "Generated automatically on the AST when an implicit abstract cast happens.",
  541. "targets": ["TExpr"],
  542. "internal": true
  543. },
  544. {
  545. "name": "ImplicitReturn",
  546. "metadata": ":implicitReturn",
  547. "doc": "Generated automatically on the AST when an implicit return is inserted for arrow function.",
  548. "targets": ["TExpr"],
  549. "internal": true
  550. },
  551. {
  552. "name": "Include",
  553. "metadata": ":include",
  554. "doc": "",
  555. "platforms": ["cpp"]
  556. },
  557. {
  558. "name": "InitPackage",
  559. "metadata": ":initPackage",
  560. "doc": "Some weird thing for Genjs we want to remove someday.",
  561. "platforms": ["js"],
  562. "internal": true
  563. },
  564. {
  565. "name": "Inline",
  566. "metadata": ":inline",
  567. "doc": "Inserted by the parser in case of `inline expr` and `inline function`.",
  568. "targets": ["TExpr"]
  569. },
  570. {
  571. "name": "InlineConstructorArgument",
  572. "metadata": ":inlineConstructorArgument",
  573. "doc": "Internally used to mark expressions that were passed as arguments of an inlined constructor.",
  574. "internal": true
  575. },
  576. {
  577. "name": "Internal",
  578. "metadata": ":internal",
  579. "doc": "Generates the annotated field/class with 'internal' access.",
  580. "platforms": ["java", "cs"],
  581. "targets": ["TClass", "TEnum", "TClassField"]
  582. },
  583. {
  584. "name": "IsVar",
  585. "metadata": ":isVar",
  586. "doc": "Forces a physical field to be generated for properties that otherwise would not require one.",
  587. "targets": ["TClassField"],
  588. "links": ["https://haxe.org/manual/class-field-property-rules.html"]
  589. },
  590. {
  591. "name": "JavaCanonical",
  592. "metadata": ":javaCanonical",
  593. "doc": "Used by the Java target to annotate the canonical path of the type.",
  594. "platforms": ["java"],
  595. "params": ["Output type package", "Output type name"],
  596. "targets": ["TClass", "TEnum"]
  597. },
  598. {
  599. "name": "JavaNative",
  600. "metadata": ":javaNative",
  601. "doc": "Automatically added by `--java-lib` on classes generated from JAR/class files.",
  602. "platforms": ["java"],
  603. "targets": ["TClass", "TEnum"],
  604. "internal": true
  605. },
  606. {
  607. "name": "JvmSynthetic",
  608. "metadata": ":jvm.synthetic",
  609. "doc": "Mark generated class, field or method as synthetic",
  610. "platforms": ["java"],
  611. "targets": ["TClass", "TEnum", "TAnyField"]
  612. },
  613. {
  614. "name": "JsRequire",
  615. "metadata": ":jsRequire",
  616. "doc": "Generate JavaScript module require expression for given extern.",
  617. "platforms": ["js"],
  618. "targets": ["TClass"],
  619. "links": ["https://haxe.org/manual/target-javascript-require.html"]
  620. },
  621. {
  622. "name": "LuaRequire",
  623. "metadata": ":luaRequire",
  624. "doc": "Generate Lua module require expression for given extern.",
  625. "platforms": ["lua"],
  626. "targets": ["TClass"]
  627. },
  628. {
  629. "name": "LuaDotMethod",
  630. "metadata": ":luaDotMethod",
  631. "doc": "Indicates that the given extern type instance should have dot-style invocation for methods instead of colon.",
  632. "platforms": ["lua"]
  633. },
  634. {
  635. "name": "Keep",
  636. "metadata": ":keep",
  637. "doc": "Causes a field or type to be kept by DCE.",
  638. "links": ["https://haxe.org/manual/cr-dce.html"]
  639. },
  640. {
  641. "name": "KeepInit",
  642. "metadata": ":keepInit",
  643. "doc": "Causes a class to be kept by DCE even if all its field are removed.",
  644. "targets": ["TClass"],
  645. "links": ["https://haxe.org/manual/cr-dce.html"]
  646. },
  647. {
  648. "name": "KeepSub",
  649. "metadata": ":keepSub",
  650. "doc": "Extends `@:keep` metadata to all implementing and extending classes.",
  651. "targets": ["TClass"],
  652. "links": ["https://haxe.org/manual/cr-dce.html"]
  653. },
  654. {
  655. "name": "LibType",
  656. "metadata": ":libType",
  657. "doc": "Used by `--net-lib` and `--java-lib` to mark a class that should not be checked (overrides, interfaces, etc) by the type loader.",
  658. "platforms": ["java", "cs"],
  659. "targets": ["TClass"],
  660. "internal": true
  661. },
  662. {
  663. "name": "LoopLabel",
  664. "metadata": ":loopLabel",
  665. "doc": "Mark loop and break expressions with a label to support breaking from within switch.",
  666. "internal": true
  667. },
  668. {
  669. "name": "Markup",
  670. "metadata": ":markup",
  671. "doc": "Used as a result of inline XML parsing.",
  672. "links": ["https://haxe.org/manual/lf-markup.html"]
  673. },
  674. {
  675. "name": "Meta",
  676. "metadata": ":meta",
  677. "doc": "Internally used to mark a class field as being the metadata field.",
  678. "internal": true
  679. },
  680. {
  681. "name": "Macro",
  682. "metadata": ":macro",
  683. "doc": "(deprecated)"
  684. },
  685. {
  686. "name": "MaybeUsed",
  687. "metadata": ":maybeUsed",
  688. "doc": "Internally used by DCE to mark fields that might be kept.",
  689. "internal": true
  690. },
  691. {
  692. "name": "MergeBlock",
  693. "metadata": ":mergeBlock",
  694. "doc": "Merge the annotated block into the current scope.",
  695. "targets": ["TExpr"]
  696. },
  697. {
  698. "name": "MultiReturn",
  699. "metadata": ":multiReturn",
  700. "doc": "Annotates an extern class as the result of multi-return function.",
  701. "platforms": ["lua"],
  702. "targets": ["TClass"],
  703. "links": ["https://haxe.org/manual/target-lua-multireturns.html"]
  704. },
  705. {
  706. "name": "MultiType",
  707. "metadata": ":multiType",
  708. "doc": "Specifies that an abstract chooses its this-type from its `@:to` functions.",
  709. "params": ["Relevant type parameters"],
  710. "targets": ["TAbstract"]
  711. },
  712. {
  713. "name": "Native",
  714. "metadata": ":native",
  715. "doc": "Rewrites the path of a type or class field during generation.",
  716. "params": ["Output path"],
  717. "targets": ["TClass", "TEnum", "TAbstract", "TClassField"],
  718. "links": ["https://haxe.org/manual/lf-externs.html"]
  719. },
  720. {
  721. "name": "NativeJni",
  722. "metadata": ":java.native",
  723. "doc": "Annotates that a function has implementation in native code through JNI.",
  724. "platforms": ["java"],
  725. "targets": ["TClassField"]
  726. },
  727. {
  728. "name": "NativeChildren",
  729. "metadata": ":nativeChildren",
  730. "doc": "Annotates that all children from a type should be treated as if it were an extern definition - platform native.",
  731. "platforms": ["java", "cs"],
  732. "targets": ["TClass"]
  733. },
  734. {
  735. "name": "NativeGen",
  736. "metadata": ":nativeGen",
  737. "doc": "Annotates that a type should be treated as if it were an extern definition - platform native.",
  738. "platforms": ["java", "cs", "python"],
  739. "targets": ["TClass", "TEnum"]
  740. },
  741. {
  742. "name": "NativeGeneric",
  743. "metadata": ":nativeGeneric",
  744. "doc": "Used internally to annotate native generic classes.",
  745. "platforms": ["cs"],
  746. "targets": ["TClass", "TEnum"],
  747. "internal": true
  748. },
  749. {
  750. "name": "NativeProperty",
  751. "metadata": ":nativeProperty",
  752. "doc": "Use native properties which will execute even with dynamic usage.",
  753. "platforms": ["cpp"]
  754. },
  755. {
  756. "name": "NativeStaticExtension",
  757. "metadata": ":nativeStaticExtension",
  758. "doc": "Converts static function syntax into member call.",
  759. "platforms": ["cpp"]
  760. },
  761. {
  762. "name": "NoCompletion",
  763. "metadata": ":noCompletion",
  764. "doc": "Prevents the compiler from suggesting completion on this field or type.",
  765. "targets": ["TClassField"],
  766. "links": ["https://haxe.org/manual/cr-completion.html"]
  767. },
  768. {
  769. "name": "NoClosure",
  770. "metadata": ":noClosure",
  771. "doc": "Prevents a method or all methods in a class from being used as a value.",
  772. "targets": ["TClass", "TClassField"]
  773. },
  774. {
  775. "name": "NoDebug",
  776. "metadata": ":noDebug",
  777. "doc": "Does not generate debug information even if `--debug` is set.",
  778. "platforms": ["flash", "cpp"],
  779. "targets": ["TClass", "TClassField"]
  780. },
  781. {
  782. "name": "NoDoc",
  783. "metadata": ":noDoc",
  784. "doc": "Prevents a type from being included in documentation generation."
  785. },
  786. {
  787. "name": "NoExpr",
  788. "metadata": ":noExpr",
  789. "doc": "Internally used to mark abstract fields which have no expression by design.",
  790. "internal": true
  791. },
  792. {
  793. "name": "NoImportGlobal",
  794. "metadata": ":noImportGlobal",
  795. "doc": "Prevents a static field from being imported with `import Class.*`.",
  796. "targets": ["TAnyField"]
  797. },
  798. {
  799. "name": "NonVirtual",
  800. "metadata": ":nonVirtual",
  801. "doc": "Declares function to be non-virtual in cpp.",
  802. "platforms": ["cpp"]
  803. },
  804. {
  805. "name": "NoPackageRestrict",
  806. "metadata": ":noPackageRestrict",
  807. "doc": "Allows a module to be accessed across all targets if found on its first type.",
  808. "internal": true
  809. },
  810. {
  811. "name": "NoPrivateAccess",
  812. "metadata": ":noPrivateAccess",
  813. "doc": "Disallow private access to anything for the annotated expression.",
  814. "targets": ["TExpr"]
  815. },
  816. {
  817. "name": "NoStack",
  818. "metadata": ":noStack",
  819. "doc": "",
  820. "platforms": ["cpp"]
  821. },
  822. {
  823. "name": "NotNull",
  824. "metadata": ":notNull",
  825. "doc": "Declares an abstract type as not accepting null values.",
  826. "targets": ["TAbstract"],
  827. "links": ["https://haxe.org/manual/types-nullability.html"]
  828. },
  829. {
  830. "name": "NoUsing",
  831. "metadata": ":noUsing",
  832. "doc": "Prevents a field from being used with static extension.",
  833. "targets": ["TClassField"],
  834. "links": ["https://haxe.org/manual/lf-static-extension.html"]
  835. },
  836. {
  837. "name": "Ns",
  838. "metadata": ":ns",
  839. "doc": "Internally used by the SWF generator to handle namespaces.",
  840. "platforms": ["flash"],
  841. "internal": true
  842. },
  843. {
  844. "name": "NullSafety",
  845. "metadata": ":nullSafety",
  846. "doc": "Enables null safety for classes or fields. Disables null safety for classes, fields or expressions if provided with `Off` as an argument.",
  847. "params": ["Off | Loose | Strict | StrictThreaded"],
  848. "targets": ["TClass", "TClassField", "TExpr"],
  849. "links": ["https://haxe.org/manual/cr-null-safety.html"]
  850. },
  851. {
  852. "name": "Objc",
  853. "metadata": ":objc",
  854. "doc": "Declares a class or interface that is used to interoperate with Objective-C code.",
  855. "platforms": ["cpp"],
  856. "targets": ["TClass"]
  857. },
  858. {
  859. "name": "ObjcProtocol",
  860. "metadata": ":objcProtocol",
  861. "doc": "Associates an interface with, or describes a function in, a native Objective-C protocol.",
  862. "platforms": ["cpp"]
  863. },
  864. {
  865. "name": "Op",
  866. "metadata": ":op",
  867. "doc": "Declares an abstract field as being an operator overload.",
  868. "params": ["The operation"],
  869. "targets": ["TAbstractField"],
  870. "links": ["https://haxe.org/manual/types-abstract-operator-overloading.html"]
  871. },
  872. {
  873. "name": "Optional",
  874. "metadata": ":optional",
  875. "doc": "Marks the field of a structure as optional.",
  876. "targets": ["TClassField"],
  877. "links": ["https://haxe.org/manual/types-nullability-optional-arguments.html"]
  878. },
  879. {
  880. "name": "Overload",
  881. "metadata": ":overload",
  882. "doc": "Allows the field to be called with different argument types.",
  883. "params": ["Function specification (no expression)"],
  884. "targets": ["TClassField"],
  885. "links": ["https://haxe.org/manual/target-javascript-external-libraries.html"]
  886. },
  887. {
  888. "name": "Persistent",
  889. "metadata": ":persistent",
  890. "doc": "Keeps the value of static variables in macro context across compilations.",
  891. "targets": ["TAnyField"],
  892. "platforms": ["eval"]
  893. },
  894. {
  895. "name": "PhpGlobal",
  896. "metadata": ":phpGlobal",
  897. "doc": "Indicates that static fields of an extern class actually are located in the global PHP namespace.",
  898. "platforms": ["php"],
  899. "targets": ["TClass"]
  900. },
  901. {
  902. "name": "PhpClassConst",
  903. "metadata": ":phpClassConst",
  904. "doc": "Indicates that a static var of an extern class is a PHP class constant.",
  905. "platforms": ["php"],
  906. "targets": ["TClassField"]
  907. },
  908. {
  909. "name": "PhpMagic",
  910. "metadata": ":phpMagic",
  911. "doc": "Treat annotated field as special PHP magic field - this meta makes compiler avoid renaming such fields on generating PHP code.",
  912. "platforms": ["php"],
  913. "targets": ["TClassField"]
  914. },
  915. {
  916. "name": "PhpNoConstructor",
  917. "metadata": ":phpNoConstructor",
  918. "doc": "Special meta for extern classes which do not have native constructor in PHP, but need a constructor in Haxe extern.",
  919. "platforms": ["php"],
  920. "targets": ["TClass"]
  921. },
  922. {
  923. "name": "Pos",
  924. "metadata": ":pos",
  925. "doc": "Sets the position of a reified expression.",
  926. "params": ["Position"],
  927. "targets": ["TExpr"],
  928. "links": ["https://haxe.org/manual/macro-reification.html"]
  929. },
  930. {
  931. "name": "Public",
  932. "metadata": ":public",
  933. "doc": "Marks a class field as being public.",
  934. "targets": ["TClassField"],
  935. "internal": true
  936. },
  937. {
  938. "name": "PublicFields",
  939. "metadata": ":publicFields",
  940. "doc": "Forces all class fields of inheriting classes to be public.",
  941. "targets": ["TClass"]
  942. },
  943. {
  944. "name": "Private",
  945. "metadata": ":private",
  946. "doc": "Marks a class field as being private.",
  947. "platforms": ["cs"],
  948. "targets": ["TClassField"]
  949. },
  950. {
  951. "name": "PrivateAccess",
  952. "metadata": ":privateAccess",
  953. "doc": "Allow private access to anything for the annotated expression.",
  954. "targets": ["TExpr"]
  955. },
  956. {
  957. "name": "Protected",
  958. "metadata": ":protected",
  959. "doc": "Marks a class field as being protected.",
  960. "platforms": ["cs", "java", "flash"],
  961. "targets": ["TClassField"]
  962. },
  963. {
  964. "name": "Property",
  965. "metadata": ":property",
  966. "doc": "Marks a field to be compiled as a native C# property.",
  967. "platforms": ["cs"],
  968. "targets": ["TClassField"]
  969. },
  970. {
  971. "name": "Pure",
  972. "metadata": ":pure",
  973. "doc": "Marks a class field, class or expression as pure (side-effect free).",
  974. "targets": ["TClass", "TClassField", "TExpr"]
  975. },
  976. {
  977. "name": "ReadOnly",
  978. "metadata": ":readOnly",
  979. "doc": "Generates a field with the `readonly` native keyword.",
  980. "platforms": ["cs"],
  981. "targets": ["TClassField"]
  982. },
  983. {
  984. "name": "RealPath",
  985. "metadata": ":realPath",
  986. "doc": "Internally used on `@:native` types to retain original path information.",
  987. "internal": true
  988. },
  989. {
  990. "name": "Remove",
  991. "metadata": ":remove",
  992. "doc": "Causes an interface to be removed from all implementing classes before generation.",
  993. "targets": ["TClass"]
  994. },
  995. {
  996. "name": "Require",
  997. "metadata": ":require",
  998. "doc": "Allows access to a field only if the specified compiler flag is set.",
  999. "params": ["Compiler flag to check"],
  1000. "targets": ["TClassField"],
  1001. "links": ["https://haxe.org/manual/lf-condition-compilation.html"]
  1002. },
  1003. {
  1004. "name": "RequiresAssign",
  1005. "metadata": ":requiresAssign",
  1006. "doc": "Used internally to mark certain abstract operator overloads.",
  1007. "internal": true
  1008. },
  1009. {
  1010. "name": "Resolve",
  1011. "metadata": ":resolve",
  1012. "doc": "Abstract fields marked with this metadata can be used to resolve unknown fields.",
  1013. "targets": ["TClassField"]
  1014. },
  1015. {
  1016. "name": "Rtti",
  1017. "metadata": ":rtti",
  1018. "doc": "Adds runtime type information.",
  1019. "targets": ["TClass"],
  1020. "links": ["https://haxe.org/manual/cr-rtti.html"]
  1021. },
  1022. {
  1023. "name": "Runtime",
  1024. "metadata": ":runtime",
  1025. "doc": "",
  1026. "internal": true
  1027. },
  1028. {
  1029. "name": "RuntimeValue",
  1030. "metadata": ":runtimeValue",
  1031. "doc": "Marks an abstract as being a runtime value.",
  1032. "targets": ["TAbstract"]
  1033. },
  1034. {
  1035. "name": "Scalar",
  1036. "metadata": ":scalar",
  1037. "doc": "Used by hxcpp to mark a custom coreType abstract.",
  1038. "platforms": ["cpp"],
  1039. "targets": ["TAbstract"]
  1040. },
  1041. {
  1042. "name": "SelfCall",
  1043. "metadata": ":selfCall",
  1044. "doc": "Translates method calls into calling object directly.",
  1045. "platforms": ["js", "lua"],
  1046. "targets": ["TClassField"],
  1047. "links": ["https://haxe.org/manual/target-javascript-external-libraries.html"]
  1048. },
  1049. {
  1050. "name": "Semantics",
  1051. "metadata": ":semantics",
  1052. "doc": "The native semantics of the type.",
  1053. "params": ["value | reference | variable"],
  1054. "targets": ["TClass", "TTypedef", "TAbstract"]
  1055. },
  1056. {
  1057. "name": "Setter",
  1058. "metadata": ":setter",
  1059. "doc": "Generates a native setter function on the given field.",
  1060. "platforms": ["flash"],
  1061. "params": ["Class field name"],
  1062. "targets": ["TClassField"]
  1063. },
  1064. {
  1065. "name": "SkipCtor",
  1066. "metadata": ":skipCtor",
  1067. "doc": "Used internally to generate a constructor as if it were a native type (no `__hx_ctor`).",
  1068. "platforms": ["java", "cs"],
  1069. "internal": true
  1070. },
  1071. {
  1072. "name": "SkipReflection",
  1073. "metadata": ":skipReflection",
  1074. "doc": "Used internally to annotate a field that shouldn't have its reflection data generated.",
  1075. "platforms": ["java", "cs"],
  1076. "targets": ["TClassField"],
  1077. "internal": true
  1078. },
  1079. {
  1080. "name": "Sound",
  1081. "metadata": ":sound",
  1082. "doc": "Includes a given .wav or .mp3 file into the target SWF and associates it with the class (must extend `flash.media.Sound`).",
  1083. "platforms": ["flash"],
  1084. "params": ["File path"],
  1085. "targets": ["TClass"],
  1086. "links": ["https://haxe.org/manual/target-flash-resources.html"]
  1087. },
  1088. {
  1089. "name": "SourceFile",
  1090. "metadata": ":sourceFile",
  1091. "doc": "Source code filename for external class.",
  1092. "platforms": ["cpp"]
  1093. },
  1094. {
  1095. "name": "StackOnly",
  1096. "metadata": ":stackOnly",
  1097. "doc": "Instances of this type can only appear on the stack.",
  1098. "platforms": ["cpp"]
  1099. },
  1100. {
  1101. "name": "StaticExtension",
  1102. "metadata": "haxe.internal.static_extension",
  1103. "doc": "Used internally to mark static extension fields.",
  1104. "internal": true
  1105. },
  1106. {
  1107. "name": "StoredTypedExpr",
  1108. "metadata": ":storedTypedExpr",
  1109. "doc": "Used internally to reference a typed expression returned from a macro.",
  1110. "internal": true
  1111. },
  1112. {
  1113. "name": "Strict",
  1114. "metadata": ":strict",
  1115. "doc": "Used to declare a native C# attribute or a native Java metadata; is type checked.",
  1116. "platforms": ["java", "cs"]
  1117. },
  1118. {
  1119. "name": "Struct",
  1120. "metadata": ":struct",
  1121. "doc": "Marks a class definition as a struct.",
  1122. "platforms": ["cs", "hl"],
  1123. "targets": ["TClass"]
  1124. },
  1125. {
  1126. "name": "StructAccess",
  1127. "metadata": ":structAccess",
  1128. "doc": "Marks an extern class as using struct access (`.`) not pointer (`->`).",
  1129. "platforms": ["cpp"],
  1130. "targets": ["TClass"]
  1131. },
  1132. {
  1133. "name": "StructInit",
  1134. "metadata": ":structInit",
  1135. "doc": "Allows one to initialize the class with a structure that matches constructor parameters.",
  1136. "targets": ["TClass"]
  1137. },
  1138. {
  1139. "name": "SuppressWarnings",
  1140. "metadata": ":suppressWarnings",
  1141. "doc": "Adds a `SuppressWarnings` annotation for the generated Java class.",
  1142. "platforms": ["java"],
  1143. "targets": ["TClass"]
  1144. },
  1145. {
  1146. "name": "TailRecursion",
  1147. "metadata": ":tailRecursion",
  1148. "doc": "Internally used for tail recursion elimination.",
  1149. "internal": true
  1150. },
  1151. {
  1152. "name": "TemplatedCall",
  1153. "metadata": ":templatedCall",
  1154. "doc": "Indicates that the first parameter of static call should be treated as a template argument.",
  1155. "platforms": ["cpp"],
  1156. "targets": ["TClassField"]
  1157. },
  1158. {
  1159. "name": "Throws",
  1160. "metadata": ":throws",
  1161. "doc": "Adds a `throws` declaration to the generated function.",
  1162. "platforms": ["java"],
  1163. "params": ["Type as String"],
  1164. "targets": ["TClassField"]
  1165. },
  1166. {
  1167. "name": "This",
  1168. "metadata": ":this",
  1169. "doc": "Internally used to pass a `this` expression to macros.",
  1170. "targets": ["TExpr"],
  1171. "internal": true
  1172. },
  1173. {
  1174. "name": "To",
  1175. "metadata": ":to",
  1176. "doc": "Specifies that the field of the abstract is a cast operation to the type identified in the function.",
  1177. "targets": ["TAbstractField"],
  1178. "links": ["https://haxe.org/manual/types-abstract-implicit-casts.html"]
  1179. },
  1180. {
  1181. "name": "ToString",
  1182. "metadata": ":toString",
  1183. "doc": "Internally used.",
  1184. "internal": true
  1185. },
  1186. {
  1187. "name": "Transient",
  1188. "metadata": ":transient",
  1189. "doc": "Adds the `transient` flag to the class field.",
  1190. "platforms": ["java"],
  1191. "targets": ["TClassField"]
  1192. },
  1193. {
  1194. "name": "ValueUsed",
  1195. "metadata": ":valueUsed",
  1196. "doc": "Internally used by DCE to mark an abstract value as used.",
  1197. "internal": true
  1198. },
  1199. {
  1200. "name": "Volatile",
  1201. "metadata": ":volatile",
  1202. "doc": "",
  1203. "platforms": ["java", "cs"]
  1204. },
  1205. {
  1206. "name": "UnifyMinDynamic",
  1207. "metadata": ":unifyMinDynamic",
  1208. "doc": "Allows a collection of types to unify to `Dynamic`.",
  1209. "targets": ["TClassField"]
  1210. },
  1211. {
  1212. "name": "Unreflective",
  1213. "metadata": ":unreflective",
  1214. "doc": "",
  1215. "platforms": ["cpp"]
  1216. },
  1217. {
  1218. "name": "Unsafe",
  1219. "metadata": ":unsafe",
  1220. "doc": "Declares a class, or a method with the C#'s `unsafe` flag.",
  1221. "platforms": ["cs"],
  1222. "targets": ["TClass", "TClassField"]
  1223. },
  1224. {
  1225. "name": "Used",
  1226. "metadata": ":used",
  1227. "doc": "Internally used by DCE to mark a class or field as used.",
  1228. "internal": true
  1229. },
  1230. {
  1231. "name": "Using",
  1232. "metadata": ":using",
  1233. "doc": "Automatically uses the argument types as static extensions for the annotated type.",
  1234. "targets": ["TClass", "TEnum", "TAbstract"],
  1235. "links": ["https://haxe.org/manual/lf-static-extension-metadata.html"]
  1236. },
  1237. {
  1238. "name": "Value",
  1239. "metadata": ":value",
  1240. "doc": "Used to store default values for fields and function arguments.",
  1241. "targets": ["TClassField"],
  1242. "internal": true
  1243. },
  1244. {
  1245. "name": "HaxeArguments",
  1246. "metadata": ":haxe.arguments",
  1247. "doc": "Used to store function arguments.",
  1248. "targets": ["TClassField"],
  1249. "internal": true
  1250. },
  1251. {
  1252. "name": "Void",
  1253. "metadata": ":void",
  1254. "doc": "Use Cpp native `void` return type.",
  1255. "platforms": ["cpp"]
  1256. },
  1257. {
  1258. "name": "NeedsExceptionStack",
  1259. "metadata": ":needsExceptionStack",
  1260. "doc": "Internally used for some of auto-generated `catch` vars",
  1261. "internal": true
  1262. }
  1263. ]