/SharedLibs/Rhino.DSL.xml

http://github.com/ayende/rhino-etl · XML · 719 lines · 714 code · 5 blank · 0 comment · 0 complexity · 1c0fce184e49b0967b86f4b7f70a8651 MD5 · raw file

  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Rhino.DSL</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Rhino.DSL.AbstractLockable">
  8. <summary>
  9. Provide local read / writer copy semantics
  10. </summary>
  11. </member>
  12. <member name="M:Rhino.DSL.AbstractLockable.WriteLock(Rhino.DSL.CacheAction)">
  13. <summary>
  14. Execute the action under a write lock
  15. </summary>
  16. <param name="cacheAction">The cache action.</param>
  17. </member>
  18. <member name="M:Rhino.DSL.AbstractLockable.ReadLock(Rhino.DSL.CacheAction)">
  19. <summary>
  20. Execute the action under a read lock
  21. </summary>
  22. <param name="cacheAction">The cache action.</param>
  23. </member>
  24. <member name="T:Rhino.DSL.BlockToArgumentsTransformer">
  25. <summary>
  26. Transforms the contents of macro blocks specified in the ctor to parameters.
  27. <example>
  28. <code>
  29. mymacro:
  30. 1
  31. "something"
  32. is transformed into
  33. mymacro(1, "something")
  34. </code>
  35. </example>
  36. </summary>
  37. </member>
  38. <member name="M:Rhino.DSL.BlockToArgumentsTransformer.#ctor(System.String[])">
  39. <summary>
  40. Creates an instance of BlockToArgumentsTransformer
  41. </summary>
  42. <param name="methods">Methods that should have blocks transformed into arguments.</param>
  43. </member>
  44. <member name="M:Rhino.DSL.BlockToArgumentsTransformer.OnMacroStatement(Boo.Lang.Compiler.Ast.MacroStatement)">
  45. <summary>
  46. Handles macro statements.
  47. </summary>
  48. <param name="node">The node.</param>
  49. </member>
  50. <member name="T:Rhino.DSL.DslCompilerContextCache">
  51. <summary>
  52. Cache for a CompilerContext instance
  53. </summary>
  54. </member>
  55. <member name="M:Rhino.DSL.DslCompilerContextCache.#ctor(Rhino.DSL.IDslEngineStorage)">
  56. <summary>
  57. Create a cache based on the script storage method
  58. </summary>
  59. <param name="storage"></param>
  60. </member>
  61. <member name="M:Rhino.DSL.DslCompilerContextCache.GetCached(Rhino.DSL.DslEngine,System.String[])">
  62. <summary>
  63. Returns cached instance if any, or null if none
  64. </summary>
  65. <param name="engine"></param>
  66. <param name="urls"></param>
  67. <returns></returns>
  68. </member>
  69. <member name="E:Rhino.DSL.DslCompilerContextCache.AssemblyLoaded">
  70. <summary>
  71. Occurs when an assembly is loaded from disk.
  72. </summary>
  73. </member>
  74. <member name="T:Rhino.DSL.AssemblyLoadEvent">
  75. <summary>
  76. The event type for loading assembly from disk
  77. </summary>
  78. </member>
  79. <member name="T:Rhino.DSL.ImplicitBaseClassCompilerStep">
  80. <summary>
  81. Takes all the code that exists in a module's global section and put it in a specificied
  82. method of a class. Allow easy handling of the Anonymous Base Class pattern
  83. </summary>
  84. </member>
  85. <member name="T:Rhino.DSL.BaseClassCompilerStep">
  86. <summary>
  87. Provides a base class for classes that provide DSL via
  88. substituting code into one or more members of a class
  89. created at runtime inheriting from a BaseClassCompilerStep.
  90. </summary>
  91. </member>
  92. <member name="M:Rhino.DSL.BaseClassCompilerStep.#ctor(System.Type,System.String[])">
  93. <summary>
  94. Create new instance of <seealso cref="T:Rhino.DSL.BaseClassCompilerStep"/>
  95. </summary>
  96. <param name="baseClass">The base class that will be used</param>
  97. <param name="namespaces">Namespaces that will be automatically imported into all modules</param>
  98. </member>
  99. <member name="M:Rhino.DSL.BaseClassCompilerStep.Run">
  100. <summary>
  101. Run this compiler step
  102. </summary>
  103. </member>
  104. <member name="M:Rhino.DSL.BaseClassCompilerStep.ExtendBaseClass(Boo.Lang.Compiler.Ast.Module,Boo.Lang.Compiler.Ast.ClassDefinition)">
  105. <summary>
  106. Allow a derived class to perform additional operations on the newly created type definition.
  107. </summary>
  108. </member>
  109. <member name="P:Rhino.DSL.BaseClassCompilerStep.BaseClass">
  110. <summary>
  111. Base class that this BaseClassCompilerStep builds a derived instance of.
  112. </summary>
  113. </member>
  114. <member name="M:Rhino.DSL.ImplicitBaseClassCompilerStep.#ctor(System.Type,System.String,System.String[])">
  115. <summary>
  116. Create new instance of <seealso cref="T:Rhino.DSL.ImplicitBaseClassCompilerStep"/>
  117. </summary>
  118. <param name="baseClass">The base class that will be used</param>
  119. <param name="methodName">The name of the method that will get all the code from globals moved to it.</param>
  120. <param name="namespaces">Namespaces that would be automatically imported into all modules</param>
  121. </member>
  122. <member name="M:Rhino.DSL.ImplicitBaseClassCompilerStep.#ctor(System.Type,System.String,Boo.Lang.Compiler.Ast.ParameterDeclarationCollection,System.String[])">
  123. <summary>
  124. Create new instance of <seealso cref="T:Rhino.DSL.ImplicitBaseClassCompilerStep"/>
  125. </summary>
  126. <param name="baseClass">The base class that will be used</param>
  127. <param name="methodName">The name of the method that will get all the code from globals moved to it.</param>
  128. <param name="parameters">The parameters of this method</param>
  129. <param name="namespaces">Namespaces that would be automatically imported into all modules</param>
  130. </member>
  131. <member name="M:Rhino.DSL.ImplicitBaseClassCompilerStep.ExtendBaseClass(Boo.Lang.Compiler.Ast.Module,Boo.Lang.Compiler.Ast.ClassDefinition)">
  132. <summary>
  133. Allow a derived class to perform additional operations on the newly created type definition.
  134. </summary>
  135. </member>
  136. <member name="M:Rhino.DSL.ImplicitBaseClassCompilerStep.ExtendBaseClass(Boo.Lang.Compiler.Ast.TypeDefinition)">
  137. <summary>
  138. Allow to extend the base class in additional ways
  139. </summary>
  140. <param name="definition">The definition.</param>
  141. </member>
  142. <member name="T:Rhino.DSL.DefaultDslEngineCache">
  143. <summary>
  144. Provide cache support for a DSL
  145. </summary>
  146. </member>
  147. <member name="T:Rhino.DSL.IDslEngineCache">
  148. <summary>
  149. Cahce interface for the DslEngine
  150. </summary>
  151. </member>
  152. <member name="M:Rhino.DSL.IDslEngineCache.Get(System.String)">
  153. <summary>
  154. Try to get a cached type for this URL.
  155. </summary>
  156. <param name="url">The url to use as a key for the cache</param>
  157. <returns>The compiled DSL or null if not found</returns>
  158. </member>
  159. <member name="M:Rhino.DSL.IDslEngineCache.Set(System.String,System.Type)">
  160. <summary>
  161. Put the type in the cache, with the url as the key
  162. </summary>
  163. </member>
  164. <member name="M:Rhino.DSL.IDslEngineCache.Remove(System.String)">
  165. <summary>
  166. Removes the url for the from cache.
  167. </summary>
  168. <param name="url">The URL.</param>
  169. </member>
  170. <member name="M:Rhino.DSL.IDslEngineCache.WriteLock(Rhino.DSL.CacheAction)">
  171. <summary>
  172. Execute the action under a write lock
  173. </summary>
  174. <param name="cacheAction">The cache action.</param>
  175. </member>
  176. <member name="M:Rhino.DSL.IDslEngineCache.ReadLock(Rhino.DSL.CacheAction)">
  177. <summary>
  178. Execute the action under a read lock
  179. </summary>
  180. <param name="cacheAction">The cache action.</param>
  181. </member>
  182. <member name="M:Rhino.DSL.DefaultDslEngineCache.Get(System.String)">
  183. <summary>
  184. Try to get a cached type for this URL.
  185. </summary>
  186. <param name="url">The url to use as a key for the cache</param>
  187. <returns>The compiled DSL or null if not found</returns>
  188. </member>
  189. <member name="M:Rhino.DSL.DefaultDslEngineCache.Set(System.String,System.Type)">
  190. <summary>
  191. Put the type in the cache, with the url as the key
  192. </summary>
  193. </member>
  194. <member name="M:Rhino.DSL.DefaultDslEngineCache.Remove(System.String)">
  195. <summary>
  196. Removes the url for the from cache.
  197. </summary>
  198. <param name="url">The URL.</param>
  199. </member>
  200. <member name="T:Rhino.DSL.FileSystemDslEngineStorage">
  201. <summary>
  202. Handles the storage requirements for the DSL from a file system.
  203. </summary>
  204. </member>
  205. <member name="T:Rhino.DSL.IDslEngineStorage">
  206. <summary>
  207. Implementors of this class will
  208. handle all the storage requirements for the DSL.
  209. Where the scripts are located, when they are refreshed, etc
  210. </summary>
  211. </member>
  212. <member name="M:Rhino.DSL.IDslEngineStorage.GetMatchingUrlsIn(System.String,System.String@)">
  213. <summary>
  214. Will retrieve all the _canonised_ urls from the given directory that
  215. this Dsl Engine can process.
  216. </summary>
  217. </member>
  218. <member name="M:Rhino.DSL.IDslEngineStorage.NotifyOnChange(System.Collections.Generic.IEnumerable{System.String},System.Action{System.String})">
  219. <summary>
  220. Will call the action delegate when any of the specified urls are changed.
  221. Note that for a single logical change several calls may be made.
  222. </summary>
  223. <param name="urls">The urls.</param>
  224. <param name="action">The action.</param>
  225. </member>
  226. <member name="M:Rhino.DSL.IDslEngineStorage.CreateInput(System.String)">
  227. <summary>
  228. Create a compiler input from the URL.
  229. </summary>
  230. <param name="url">The url</param>
  231. <returns>The compiler input</returns>
  232. </member>
  233. <member name="M:Rhino.DSL.IDslEngineStorage.IsUrlIncludeIn(System.String[],System.String,System.String)">
  234. <summary>
  235. Determines whether the URL is included in the specified urls
  236. in the given parent path
  237. </summary>
  238. <param name="urls">The urls.</param>
  239. <param name="parentPath">The parent oath.</param>
  240. <param name="url">The URL.</param>
  241. <returns>
  242. <c>true</c> if [is URL include in] [the specified urls]; otherwise, <c>false</c>.
  243. </returns>
  244. </member>
  245. <member name="M:Rhino.DSL.IDslEngineStorage.GetTypeNameFromUrl(System.String)">
  246. <summary>
  247. Gets the type name from URL.
  248. </summary>
  249. <param name="url">The URL.</param>
  250. <returns></returns>
  251. </member>
  252. <member name="M:Rhino.DSL.IDslEngineStorage.IsValidScriptUrl(System.String)">
  253. <summary>
  254. Determains whatever the given url is a valid script url.
  255. </summary>
  256. </member>
  257. <member name="M:Rhino.DSL.IDslEngineStorage.GetChecksumForUrls(System.Type,System.Collections.Generic.IEnumerable{System.String})">
  258. <summary>
  259. Given a set of script URLs return a checksum for them taking into account their location and their contents
  260. </summary>
  261. <param name="dslEngineType">Type of the DSL base.</param>
  262. <param name="urls">The urls.</param>
  263. <returns></returns>
  264. </member>
  265. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.CreateInput(System.String)">
  266. <summary>
  267. Create a compiler input from the URL.
  268. </summary>
  269. <param name="url">The url</param>
  270. <returns>The compiler input</returns>
  271. </member>
  272. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.GetMatchingUrlsIn(System.String,System.String@)">
  273. <summary>
  274. Will retrieve all the _canonised_ urls from the given directory that
  275. this Dsl Engine can process.
  276. </summary>
  277. </member>
  278. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.CompareUrls(System.String,System.String)">
  279. <summary>
  280. Compares the two urls
  281. </summary>
  282. <param name="x">The x.</param>
  283. <param name="y">The y.</param>
  284. <returns></returns>
  285. </member>
  286. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.NotifyOnChange(System.Collections.Generic.IEnumerable{System.String},System.Action{System.String})">
  287. <summary>
  288. Will call the action delegate when any of the specified urls are changed.
  289. Note that for a single logical change several calls may be made.
  290. </summary>
  291. <param name="urls">The urls.</param>
  292. <param name="action">The action.</param>
  293. </member>
  294. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.IsUrlIncludeIn(System.String[],System.String,System.String)">
  295. <summary>
  296. Determines whether the URL is included in the specified urls
  297. in the given parent path
  298. </summary>
  299. <param name="urls">The urls.</param>
  300. <param name="parentPath">The parent oath.</param>
  301. <param name="url">The URL.</param>
  302. <returns>
  303. <c>true</c> if [is URL include in] [the specified urls]; otherwise, <c>false</c>.
  304. </returns>
  305. </member>
  306. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.GetTypeNameFromUrl(System.String)">
  307. <summary>
  308. Gets the type name from URL.
  309. </summary>
  310. <param name="url">The URL.</param>
  311. <returns></returns>
  312. </member>
  313. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.IsValidScriptUrl(System.String)">
  314. <summary>
  315. Determains whatever the given url is a valid script url.
  316. </summary>
  317. </member>
  318. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.GetChecksumForUrls(System.Type,System.Collections.Generic.IEnumerable{System.String})">
  319. <summary>
  320. Given a set of script URLs return a checksum for them
  321. </summary>
  322. <param name="dslEngineType">Type of the DSL base.</param>
  323. <param name="urls">The urls.</param>
  324. <returns></returns>
  325. </member>
  326. <member name="M:Rhino.DSL.FileSystemDslEngineStorage.Dispose">
  327. <summary>
  328. Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
  329. </summary>
  330. <filterpriority>2</filterpriority>
  331. </member>
  332. <member name="P:Rhino.DSL.FileSystemDslEngineStorage.FileNameFormat">
  333. <summary>
  334. The file name format of this DSL
  335. </summary>
  336. </member>
  337. <member name="T:Rhino.DSL.CacheAction">
  338. <summary>
  339. An action delegate to be executed under a cache lock
  340. </summary>
  341. </member>
  342. <member name="T:Rhino.DSL.MethodSubstitutionBaseClassCompilerStep">
  343. <summary>
  344. Takes all macro statements that exist in the modules global section and puts the bodies of those methods
  345. into corresponding overridable methods on the base class.
  346. </summary>
  347. </member>
  348. <member name="M:Rhino.DSL.MethodSubstitutionBaseClassCompilerStep.#ctor(System.Type,System.String[])">
  349. <summary>
  350. Create an instance of MethodSubstitutionBaseClassCompilerStep
  351. </summary>
  352. </member>
  353. <member name="M:Rhino.DSL.MethodSubstitutionBaseClassCompilerStep.#ctor(System.Type,Boo.Lang.Compiler.Ast.DepthFirstTransformer[],System.String[])">
  354. <summary>
  355. Create an instance of MethodSubstitutionBaseClassCompilerStep
  356. </summary>
  357. </member>
  358. <member name="M:Rhino.DSL.MethodSubstitutionBaseClassCompilerStep.ExtendBaseClass(Boo.Lang.Compiler.Ast.Module,Boo.Lang.Compiler.Ast.ClassDefinition)">
  359. <summary>
  360. Extends the base class by placing the blocks of macros into methods on the base class
  361. of the same name.
  362. </summary>
  363. <example>
  364. MyMethod:
  365. PerformActions
  366. If an overridable method called MyMethod exists on <see cref="P:Rhino.DSL.BaseClassCompilerStep.BaseClass"/>, then
  367. it is overridden as follows:
  368. <code>
  369. public override void MyMethod() { PerformActions(); }
  370. </code>
  371. </example>
  372. </member>
  373. <member name="T:Rhino.DSL.TransformerCompilerStep">
  374. <summary>
  375. Compiler step to run <see cref="T:Boo.Lang.Compiler.Ast.DepthFirstTransformer"/>s.
  376. </summary>
  377. <remarks>
  378. This is a useful way to apply one or more transformers as a compiler step.
  379. </remarks>
  380. </member>
  381. <member name="M:Rhino.DSL.TransformerCompilerStep.#ctor(Boo.Lang.Compiler.Ast.DepthFirstTransformer[])">
  382. <summary>
  383. Creates an instance of TransformerCompilerStep.
  384. </summary>
  385. <param name="transformers">Transformers for this compiler step to run.</param>
  386. <exception cref="T:System.ArgumentNullException"><paramref name="transformers"/> should not be null.</exception>
  387. <exception cref="T:System.ArgumentException"><paramref name="transformers"/> should have at least one element.</exception>
  388. </member>
  389. <member name="M:Rhino.DSL.TransformerCompilerStep.Run">
  390. <summary>
  391. Run the <see cref="T:Rhino.DSL.TransformerCompilerStep"/>.
  392. </summary>
  393. </member>
  394. <member name="T:Rhino.DSL.UnderscoreNamingConventionsToPascalCaseCompilerStep">
  395. <summary>
  396. Allow to use underscore separated names, which will be translated to pascal case names.
  397. pascal_case -> PascalCase.
  398. All names that contains an underscores will go through this treatment.
  399. </summary>
  400. <example>
  401. You can enable this behavior using the following statement
  402. <code>
  403. compiler.Parameters.Pipeline
  404. .InsertBefore(typeof (ProcessMethodBodiesWithDuckTyping),
  405. new UnderscoreNamingConventionsToPascalCaseCompilerStep());
  406. </code>
  407. </example>
  408. </member>
  409. <member name="M:Rhino.DSL.UnderscoreNamingConventionsToPascalCaseCompilerStep.OnReferenceExpression(Boo.Lang.Compiler.Ast.ReferenceExpression)">
  410. <summary>
  411. Called when we encounter a reference expression
  412. </summary>
  413. <param name="node">The node.</param>
  414. </member>
  415. <member name="M:Rhino.DSL.UnderscoreNamingConventionsToPascalCaseCompilerStep.ShouldTransformNodeName(Boo.Lang.Compiler.Ast.ReferenceExpression)">
  416. <summary>
  417. Determain if the the name of the node should be transformed.
  418. </summary>
  419. <param name="node">The node.</param>
  420. <returns></returns>
  421. </member>
  422. <member name="M:Rhino.DSL.UnderscoreNamingConventionsToPascalCaseCompilerStep.OnMemberReferenceExpression(Boo.Lang.Compiler.Ast.MemberReferenceExpression)">
  423. <summary>
  424. Called when we encounters a member reference expression
  425. </summary>
  426. <param name="node">The node.</param>
  427. </member>
  428. <member name="M:Rhino.DSL.UnderscoreNamingConventionsToPascalCaseCompilerStep.TransformNodeName(Boo.Lang.Compiler.Ast.ReferenceExpression)">
  429. <summary>
  430. Sets the node name to pascal case.
  431. </summary>
  432. <param name="node">The node.</param>
  433. </member>
  434. <member name="M:Rhino.DSL.UnderscoreNamingConventionsToPascalCaseCompilerStep.Run">
  435. <summary>
  436. Start visiting the current compile unit
  437. </summary>
  438. </member>
  439. <member name="T:Rhino.DSL.UseSymbolsStep">
  440. <summary>
  441. Translate all @foo reference expression to "foo" string literals.
  442. In essense, add symbols to the language
  443. </summary>
  444. </member>
  445. <member name="M:Rhino.DSL.UseSymbolsStep.Run">
  446. <summary>
  447. Runs this instance.
  448. </summary>
  449. </member>
  450. <member name="M:Rhino.DSL.UseSymbolsStep.OnReferenceExpression(Boo.Lang.Compiler.Ast.ReferenceExpression)">
  451. <summary>
  452. Called when visting a reference expression.
  453. Will turn reference expressions with initial @ to string literals
  454. </summary>
  455. <param name="node">The node.</param>
  456. </member>
  457. <member name="T:Rhino.DSL.AutoImportCompilerStep">
  458. <summary>
  459. Automatically imports all the specified namespaces to all the modules
  460. in the compilation unit
  461. </summary>
  462. <remarks>
  463. This probably belongs early in the compilation process
  464. </remarks>
  465. </member>
  466. <member name="M:Rhino.DSL.AutoImportCompilerStep.#ctor(System.String[])">
  467. <summary>
  468. Initializes a new instance of the <see cref="T:Rhino.DSL.AutoImportCompilerStep"/> class.
  469. </summary>
  470. <param name="namespaces">The namespaces.</param>
  471. </member>
  472. <member name="M:Rhino.DSL.AutoImportCompilerStep.Run">
  473. <summary>
  474. Runs this instance.
  475. </summary>
  476. </member>
  477. <member name="M:Rhino.DSL.AutoImportCompilerStep.OnModule(Boo.Lang.Compiler.Ast.Module)">
  478. <summary>
  479. Add the namespaces to the module
  480. </summary>
  481. </member>
  482. <member name="T:Rhino.DSL.UrlResolverDelegate">
  483. <summary>
  484. This delegate is used to abstract getting the data from a url.
  485. This allows us to plug in more smarts when needed (for instance, hooking into the
  486. Castle.Resources system)
  487. </summary>
  488. </member>
  489. <member name="T:Rhino.DSL.AutoReferenceFilesCompilerStep">
  490. <summary>
  491. This compiler step will auotmatically compiler and reference all files specified in import clauses such as:
  492. import file from "[file name]"
  493. Another option is:
  494. import namespaces from "[file name]"
  495. In which case all the namespaces defined in that file will be imported into the current file
  496. </summary>
  497. </member>
  498. <member name="M:Rhino.DSL.AutoReferenceFilesCompilerStep.#ctor">
  499. <summary>
  500. Create a new instance of <seealso cref="T:Rhino.DSL.AutoReferenceFilesCompilerStep"/>
  501. </summary>
  502. </member>
  503. <member name="M:Rhino.DSL.AutoReferenceFilesCompilerStep.#ctor(System.String)">
  504. <summary>
  505. Create a new instance of <seealso cref="T:Rhino.DSL.AutoReferenceFilesCompilerStep"/>
  506. </summary>
  507. <param name="baseDirectory">The base directory to resolve files from</param>
  508. </member>
  509. <member name="M:Rhino.DSL.AutoReferenceFilesCompilerStep.#ctor(Rhino.DSL.UrlResolverDelegate)">
  510. <summary>
  511. Create a new instance of <seealso cref="T:Rhino.DSL.AutoReferenceFilesCompilerStep"/>
  512. </summary>
  513. <param name="urlResolver">The url resolver to use</param>
  514. </member>
  515. <member name="M:Rhino.DSL.AutoReferenceFilesCompilerStep.#ctor(System.String,Rhino.DSL.UrlResolverDelegate)">
  516. <summary>
  517. Create a new instance of <seealso cref="T:Rhino.DSL.AutoReferenceFilesCompilerStep"/>
  518. </summary>
  519. <param name="baseDirectory">The base directory to resolve files from</param>
  520. <param name="urlResolver">The url resolver to use</param>
  521. </member>
  522. <member name="M:Rhino.DSL.AutoReferenceFilesCompilerStep.OnImport(Boo.Lang.Compiler.Ast.Import)">
  523. <summary>
  524. Add the desired import behavior.
  525. </summary>
  526. </member>
  527. <member name="M:Rhino.DSL.AutoReferenceFilesCompilerStep.SafeCloneParameters(Boo.Lang.Compiler.CompilerParameters)">
  528. <summary>
  529. This creates a copy of the passed compiler parameters, without the stuff
  530. that make a compilation unique, like input, output assembly, etc
  531. </summary>
  532. <param name="parameters"></param>
  533. <returns></returns>
  534. </member>
  535. <member name="M:Rhino.DSL.AutoReferenceFilesCompilerStep.Run">
  536. <summary>
  537. Run the current compiler step
  538. </summary>
  539. </member>
  540. <member name="T:Rhino.DSL.DslEngine">
  541. <summary>
  542. Base class for DSL engines, handles most of the routine tasks that a DSL
  543. engine needs to do. Compilation, caching, creation, etc.
  544. </summary>
  545. </member>
  546. <member name="M:Rhino.DSL.DslEngine.#ctor">
  547. <summary>
  548. Initializes a new instance of the <see cref="T:Rhino.DSL.DslEngine"/> class.
  549. </summary>
  550. </member>
  551. <member name="M:Rhino.DSL.DslEngine.CreateInstance(System.Type,System.Object[])">
  552. <summary>
  553. Create a new instance of this DSL type.
  554. </summary>
  555. <param name="type">The type to create</param>
  556. <param name="parametersForConstructor">optional ctor paraemters</param>
  557. <returns>The newly created instance</returns>
  558. </member>
  559. <member name="M:Rhino.DSL.DslEngine.Compile(System.String[])">
  560. <summary>
  561. Compile the DSL and return the resulting context
  562. </summary>
  563. <param name="urls">The files to compile</param>
  564. <returns>The resulting compiler context</returns>
  565. </member>
  566. <member name="M:Rhino.DSL.DslEngine.ForceCompile(System.String[],System.String)">
  567. <summary>
  568. Force a compile with no caching
  569. </summary>
  570. <param name="urls">The urls.</param>
  571. <param name="cacheFileName">Name of the cache file.</param>
  572. <returns></returns>
  573. </member>
  574. <member name="M:Rhino.DSL.DslEngine.HandleWarnings(Boo.Lang.Compiler.CompilerWarningCollection)">
  575. <summary>
  576. Allow a derived class to get access to the warnings that occured during
  577. compilation
  578. </summary>
  579. <param name="warnings">The warnings.</param>
  580. </member>
  581. <member name="M:Rhino.DSL.DslEngine.CreateCompilerException(Boo.Lang.Compiler.CompilerContext)">
  582. <summary>
  583. Create an exception that would be raised on compilation errors.
  584. </summary>
  585. <param name="context"></param>
  586. <returns></returns>
  587. </member>
  588. <member name="M:Rhino.DSL.DslEngine.CustomizeCompiler(Boo.Lang.Compiler.BooCompiler,Boo.Lang.Compiler.CompilerPipeline,System.String[])">
  589. <summary>
  590. Customise the compiler to fit this DSL engine.
  591. This is the most commonly overriden method.
  592. </summary>
  593. </member>
  594. <member name="M:Rhino.DSL.DslEngine.GetTypeForUrl(System.Reflection.Assembly,System.String)">
  595. <summary>
  596. Get a type from the assembly according to the URL.
  597. This is used to match a class with its originating file
  598. </summary>
  599. </member>
  600. <member name="M:Rhino.DSL.DslEngine.CanonizeUrl(System.String)">
  601. <summary>
  602. Canonizes the URL to a consistent form.
  603. </summary>
  604. </member>
  605. <member name="P:Rhino.DSL.DslEngine.Cache">
  606. <summary>
  607. Gets or sets the cache.
  608. </summary>
  609. <value>The cache.</value>
  610. </member>
  611. <member name="P:Rhino.DSL.DslEngine.Storage">
  612. <summary>
  613. Gets or sets the storage for this DSL
  614. </summary>
  615. <value>The storage.</value>
  616. </member>
  617. <member name="P:Rhino.DSL.DslEngine.CompilerContextCache">
  618. <summary>
  619. Compiler context cache
  620. </summary>
  621. </member>
  622. <member name="P:Rhino.DSL.DslEngine.CompilerOutputType">
  623. <summary>
  624. The type of assembly compilation should produce
  625. </summary>
  626. </member>
  627. <member name="T:Rhino.DSL.DslFactory">
  628. <summary>
  629. Manage the creation of DSL instances, cache and creates them.
  630. </summary>
  631. </member>
  632. <member name="F:Rhino.DSL.DslFactory.standAloneCompilation">
  633. <summary>
  634. This is used to mark urls that should be compiled on their own
  635. usually this means scripts that has been changed after they were
  636. compiled
  637. </summary>
  638. </member>
  639. <member name="M:Rhino.DSL.DslFactory.Register``1(Rhino.DSL.DslEngine)">
  640. <summary>
  641. Register a new DSL engine that is tied to a specific base type
  642. </summary>
  643. </member>
  644. <member name="M:Rhino.DSL.DslFactory.Create``1(System.String,System.Object[])">
  645. <summary>
  646. Create a new DSL instance
  647. </summary>
  648. <typeparam name="TDslBase">The base type of the DSL</typeparam>
  649. <param name="url">The url to read the DSL file from</param>
  650. <param name="parameters">optional ctor parameters</param>
  651. <returns>The dsl instance</returns>
  652. </member>
  653. <member name="M:Rhino.DSL.DslFactory.TryCreate``1(System.String,System.Object[])">
  654. <summary>
  655. Create a new DSL instance
  656. </summary>
  657. <typeparam name="TDslBase">The base type of the DSL</typeparam>
  658. <param name="url">The url to read the DSL file from</param>
  659. <param name="parameters">optional ctor parameters</param>
  660. <returns>The dsl instance</returns>
  661. </member>
  662. <member name="M:Rhino.DSL.DslFactory.CreateAll``1(System.String,System.Object[])">
  663. <summary>
  664. Creates instances of all the DSL that are located directly under the parent URL.
  665. </summary>
  666. <typeparam name="TDslBase">The type of the DSL base.</typeparam>
  667. <param name="parentUrl">The parent URL.</param>
  668. <param name="parameters">The parameters.</param>
  669. <returns></returns>
  670. </member>
  671. <member name="M:Rhino.DSL.DslFactory.IsRegistered``1">
  672. <summary>
  673. Check if there was a DSL registered for this base type.
  674. </summary>
  675. </member>
  676. <member name="P:Rhino.DSL.DslFactory.BaseDirectory">
  677. <summary>
  678. The base directory to read all the relative url from.
  679. </summary>
  680. </member>
  681. <member name="E:Rhino.DSL.DslFactory.Compilation">
  682. <summary>
  683. Occurs when a compilation is completed
  684. Useful to track how many assemblies has been loaded
  685. by the DslFactory
  686. </summary>
  687. </member>
  688. <member name="E:Rhino.DSL.DslFactory.Recompilation">
  689. <summary>
  690. Occurs when recompilation of a script is completed.
  691. Useful to track how many assemblies has been loaded by
  692. the DslFactory
  693. </summary>
  694. </member>
  695. <member name="T:Rhino.DSL.GeneratePropertyMacro">
  696. <summary>
  697. This class allows to easily define property generation macros
  698. </summary>
  699. </member>
  700. <member name="M:Rhino.DSL.GeneratePropertyMacro.#ctor(System.String)">
  701. <summary>
  702. Initializes a new instance of the <see cref="T:Rhino.DSL.GeneratePropertyMacro"/> class.
  703. </summary>
  704. <param name="propertyName">Name of the property.</param>
  705. </member>
  706. <member name="M:Rhino.DSL.GeneratePropertyMacro.Expand(Boo.Lang.Compiler.Ast.MacroStatement)">
  707. <summary>
  708. Expands the specified macro.
  709. </summary>
  710. <param name="macro">The macro.</param>
  711. <returns></returns>
  712. </member>
  713. </members>
  714. </doc>