Me.html 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>Class Me</title>
  5. <link rel="stylesheet" type="text/css" href="doc.css" />
  6. </head>
  7. <body>
  8. <div class='body'>
  9. <div class="content">
  10. <a name='top'></a>
  11. <h1 class='className'>Me</h1>
  12. <div class='classBlock'>
  13. <table class='classHead' title='Me'>
  14. <tr><td><strong>Module</strong></td><td>embedthis.me</td></tr>
  15. <tr><td><strong>Definition</strong></td><td>dynamic class Me</td></tr>
  16. <tr><td><strong>Inheritance</strong></td><td>Me <img src='images/inherit.gif' alt='inherit'/> <a href='Object.html'>Object</a><tr><td><strong>Stability</strong></td><td>Prototype.</td></tr>
  17. </td></tr>
  18. </table>
  19. <p class='classBrief'>The Me class is the MakeMe Document Object Model (DOM).</p>
  20. <p class='classDescription'>This class defined core properties and exposes no methods. Instances are dynamic and may create new
  21. properties at runtime.</p>
  22. </div>
  23. <hr />
  24. <a name='Properties'></a>
  25. <h2 class='classSection'>Properties</h2>
  26. <table class='itemTable' title='properties'>
  27. <tr><th>Qualifiers</th><th>Property</th><th>Type</th><th width='95%'>Description</th></tr>
  28. <a name='blend'></a>
  29. <tr><td nowrap align='center'> </td><td>blend</td><td><a href='Array.html'>Array</a></td><td>Array of files to load. These paths may include the wild-card "*"" character to
  30. match a filename portion and "***"" to match any file or directory at any depth in the directory
  31. tree. If the filename is not found, "~/.paks" is searched for a matching Pak.</td></tr>
  32. <a name='configure'></a>
  33. <tr><td nowrap align='center'> </td><td>configure</td><td><a href='Object.html'>Object</a></td><td>The configure collection specifies the configurable targets used to extend the project. The 'discovers' property
  34. The 'discovers' property lists optional configurable targets to discover when configuring.
  35. The 'requires' property lists required targets to discover when configuring.
  36. The 'extras' property lists components that will not be discovered but can be included via an explicit
  37. 'configure --with NAME'.</td></tr>
  38. <a name='customize'></a>
  39. <tr><td nowrap align='center'> </td><td>customize</td><td><a href='Array.html'>Array</a></td><td>Optional MakeMe files to load after fully loading all blended MakeMe files. </td></tr>
  40. <a name='defaults'></a>
  41. <tr><td nowrap align='center'> </td><td>defaults</td><td><a href='Object.html'>Object</a></td><td>Default properties to be inherited by all targets. </td></tr>
  42. <a name='dir'></a>
  43. <tr><td nowrap align='center'> </td><td>dir</td><td><a href='Object.html'>Object</a></td><td>Directories used by MakeMe. These must be absolute paths so that they can be used when the
  44. current directory is changed while processing.</td></tr>
  45. <a name='env'></a>
  46. <tr><td nowrap align='center'> </td><td>env</td><td><a href='Object.html'>Object</a></td><td>Environment variables to set when compiling and linking. </td></tr>
  47. <a name='ext'></a>
  48. <tr><td nowrap align='center'> </td><td>ext</td><td><a href='Object.html'>Object</a></td><td>File extensions indexed by file type. </td></tr>
  49. <a name='globals'></a>
  50. <tr><td nowrap align='center'> </td><td>globals</td><td><a href='Object.html'>Object</a></td><td>Global values to use in property token expansion. </td></tr>
  51. <a name='internal'></a>
  52. <tr><td nowrap align='center'> </td><td>internal</td><td><a href='Object.html'>Object</a></td><td>Default properties to be inherited by only the targets in the same MakeMe file. </td></tr>
  53. <a name='mixin'></a>
  54. <tr><td nowrap align='center'> </td><td>mixin</td><td><a href='Array.html'>Array</a></td><td>Literal script code to mixin. The script is injected into the global scope.</td></tr>
  55. <a name='modules'></a>
  56. <tr><td nowrap align='center'> </td><td>modules</td><td><a href='Array.html'>Array</a></td><td>List of scripts or compiled scripts to pre-load. </td></tr>
  57. <a name='options'></a>
  58. <tr><td nowrap align='center'> </td><td>options</td><td><a href='Object.html'>Object</a></td><td>Reference to the MakeMe command line options object. </td></tr>
  59. <a name='platform'></a>
  60. <tr><td nowrap align='center'> </td><td>platform</td><td><a href='Object.html'>Object</a></td><td>Description of the current platform. Has properties for operating system and CPU architecture.</td></tr>
  61. <a name='prefixes'></a>
  62. <tr><td nowrap align='center'> </td><td>prefixes</td><td><a href='Object.html'>Object</a></td><td>Installation directory prefixes and default values on Unix/Linux systems. </td></tr>
  63. <a name='profiles'></a>
  64. <tr><td nowrap align='center'> </td><td>profiles</td><td><a href='Object.html'>Object</a></td><td>Build profiles. Standard profiles are: debug and release.</td></tr>
  65. <a name='rules'></a>
  66. <tr><td nowrap align='center'> </td><td>rules</td><td><a href='Object.html'>Object</a></td><td>Command rules for compiling, building libraries and executables. </td></tr>
  67. <a name='scripts'></a>
  68. <tr><td nowrap align='center'> </td><td>scripts</td><td><a href='Object.html'>Object</a></td><td>Top-level scripts to execute (. </td></tr>
  69. <a name='settings'></a>
  70. <tr><td nowrap align='center'> </td><td>settings</td><td><a href='Object.html'>Object</a></td><td>Project top-level settings. This includes name, version, description. See settings collection below for full details.</td></tr>
  71. <a name='target'></a>
  72. <tr><td nowrap align='center'> </td><td>target</td><td><a href='Target.html'>Target</a></td><td>Reference to the currently building target. </td></tr>
  73. <a name='targets'></a>
  74. <tr><td nowrap align='center'> </td><td>targets</td><td><a href='Object.html'>Object</a></td><td>Targets to build. Each target is its own collection of properties.</td></tr>
  75. <a name='usage'></a>
  76. <tr><td nowrap align='center'> </td><td>usage</td><td><a href='Object.html'>Object</a></td><td>Additional usage message to emit for MakeMe command line errors. </td></tr>
  77. </table>
  78. <p class='inheritedLink'><a href='Object.html#Properties'><i>Inherited Properties</i></a></p>
  79. <hr />
  80. <a name='ClassMethods'></a>
  81. <h2 class='classSection'>Me Class Methods</h2>
  82. <table class='apiIndex' title='methods'>
  83. <tr><th>Qualifiers</th><th width='95%'>Method</th></tr>
  84. <tr class='apiDef'><td class='apiType'>static </td><td><a href='#load'><b>load</b></a>(obj: <a href='Object.html'>Object</a>)</tr><tr class='apiBrief'><td>&nbsp;</td><td>Load a MakeMe literal object.</td></tr>
  85. </table>
  86. <p class='inheritedLink'><a href='Object.html#InstanceMethods'><i>Inherited Methods</i></a></p>
  87. <hr />
  88. <a name='InstanceMethods'></a>
  89. <h2 class='classSection'>Me Instance Methods</h2>
  90. <table class='apiIndex' title='methods'>
  91. <tr><th>Qualifiers</th><th width='95%'>Method</th></tr>
  92. <p>(No own instance methods defined)</p></table>
  93. <p class='inheritedLink'><a href='Object.html#InstanceMethods'><i>Inherited Methods</i></a></p>
  94. <hr />
  95. <h2>Method Detail</h2>
  96. <a name='load'></a>
  97. <div class='api'>
  98. <div class='apiSig'>static load(obj: <a href='Object.html'>Object</a>)
  99. </div>
  100. <div class='apiDetail'>
  101. <dl><dt>Description</dt></dd><dd>Load a MakeMe literal object. Called by MakeMe files via "Me.load()" to load the MakeMe literal definition.
  102. This simply saves a reference to the object that is processed later.</dd></dl>
  103. </div>
  104. </div>
  105. <hr />
  106. <div class="terms">
  107. <p class="terms">
  108. <a href="https://www.embedthis.com/"> Embedthis Software LLC, 2003-2014. All rights reserved. Embedthis is a trademark of Embedthis Software LLC.</a>
  109. </p>
  110. </div></div>
  111. </div>
  112. </body>
  113. </html>