SPeCS Research Group

User Tools

Site Tools

Trace:
doc:lara:tips

Warning: Undefined array key -1 in /home/feupptspecs/public_html/wiki/inc/html.php on line 1458

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
doc:lara:tips [2022/01/15 19:47]
jbispo 		doc:lara:tips [2022/01/15 20:20] (current)
jbispo
Line 1: Line 1:
 ====== LARA General Tips ====== ====== LARA General Tips ======
  
 +===== Naming Conventions =====
  
-==== Regular Expressions ====+General Javascript styling guides apply, such as: 
 +  * Variable names and functions use camelCase with the first letter in lowercase 
 +  * Class names should be nouns, in use CamelCase with the first letter of each internal word capitalized 
 +  * Global variables use ALLCAPS 
 +  * Private functions/members start with underscore '_' (they will not appear in the generated documentation) 
 + 
 +LARA-specific constructs have the following rules: 
 +  * Aspect names follow the same rules of Classes 
 +  * Join point attributes and actions follow the same rules as variable names and functions 
 + 
 + 
 +/* Furthermore, since importing will evaluate all imported LARA and JS scripts in the same context, to help keep things organized, */ 
 + 
 +We highly recommend that LARA/JS scripts declare a single global variable or class with the same name as the script (e.g., file Query.js/.lara declares a new class/aspect Query). 
 + 
 + 
 +===== Regular Expressions =====
  
 Lara supports JavaScript regular expressions, for instance: Lara supports JavaScript regular expressions, for instance:
Line 37: Line 54:
 </code> </code>
  
-==== Importing LARA Files ====+===== Importing LARA Files =====
  
 LARA supports importing LARA files (with extension .lara) that are present in the include path (flag -i) using the keyword **import**. To import a file, you have to use the path to the file from the include folder, using '.' as separator and omitting the extension of the file. For instance, if you add as include the folder ~/foo and you want to import the file ~/foo/bar/Aspect.lara, you can write the following code: LARA supports importing LARA files (with extension .lara) that are present in the include path (flag -i) using the keyword **import**. To import a file, you have to use the path to the file from the include folder, using '.' as separator and omitting the extension of the file. For instance, if you add as include the folder ~/foo and you want to import the file ~/foo/bar/Aspect.lara, you can write the following code:
Line 49: Line 66:
 Import statements must be the first statements in a LARA file. LARA weavers come bundled with support for a set of imports, which are part of their API (e.g., [[http://specs.fe.up.pt/tools/clava/doc/|Clava API]]). Import statements must be the first statements in a LARA file. LARA weavers come bundled with support for a set of imports, which are part of their API (e.g., [[http://specs.fe.up.pt/tools/clava/doc/|Clava API]]).
  
-==== Importing JS Files ====+===== Importing JS Files =====
  
-All JS files (with extension .js) that are present in folders of the include path are automatically evaluated before any LARA file. However, there is a mechanism for importing specific JS files at the same time as LARA files.  +JS files that are present in an include path can be imported using the LARA keyword **import**. The same rules of importing of LARA files apply. For instance, if you add as include the folder ~/src-js and you want to import the file ~/src-js/bar/Foo.js, you can write the following code:
- +
-When the name of a folder of the include path ends with '-lara', the JS files are not automatically loaded, but instead, must be imported using the keyword **import**. The same rules of importing of LARA files apply. For instance, if you add as include the folder ~/src-lara and you want to import the file ~/src-lara/bar/Foo.js, you can write the following code:+
  
 <code lara> <code lara>
Line 66: Line 81:
 Furthermore, since importing will evaluate all imported LARA and JS scripts in the same context, to help keep things organized, we recommend that LARA/JS scripts declare a single variable/class with the same name as the import (e.g., importing weaver.Query declares a new class Query). Furthermore, since importing will evaluate all imported LARA and JS scripts in the same context, to help keep things organized, we recommend that LARA/JS scripts declare a single variable/class with the same name as the import (e.g., importing weaver.Query declares a new class Query).
  
-Since LARA is based on an older version of JS (i.e. EcmaScript 5), many recent JavaScript features are not available in LARA code. We recommend using JS files in order to have access to more recent features of JavaScript. Currently the LARA framework supports EcmaScript 2021 for JS files. +Since LARA scripts are based on an older version of JS (i.e. EcmaScript 5), many recent JavaScript features are not available in LARA code. We recommend using JS files in order to have access to more recent features of JavaScript. 
-==== Reading/Writing JSON Files ====+ 
 +/* Currently the LARA framework supports EcmaScript 2021 for JS files. */ 
 +===== Reading/Writing JSON Files =====
  
 LARA supports reading from and writing to JSON objects with the object **Io**: LARA supports reading from and writing to JSON objects with the object **Io**:
Line 82: Line 99:
  
  
-==== Testing the type of a join point ====+===== Testing the type of a join point =====
  
 All join points have the attribute ''.joinPointType'', which you might feel tempted to use to check the type of a join point, for further processing. However, it is highly preferable to use ''.instanceOf(<join_point_name>)'' instead. All join points have the attribute ''.joinPointType'', which you might feel tempted to use to check the type of a join point, for further processing. However, it is highly preferable to use ''.instanceOf(<join_point_name>)'' instead.
  
 This respects the join point hierarchy (e.g., "call" and "expr" can both return true) and is more robust than directly checking the name of the join point, i.e. ''$jp.joinPointType === "call"''. This respects the join point hierarchy (e.g., "call" and "expr" can both return true) and is more robust than directly checking the name of the join point, i.e. ''$jp.joinPointType === "call"''.
doc/lara/tips.1642276076.txt.gz · Last modified: 2022/01/15 19:47 by jbispo

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki