Changes between Version 23 and Version 24 of ErlangShellInterface

Timestamp:

Jan 31, 2013, 10:26:48 AM (12 years ago)

Author:

manualwiki

Comment:

--

ErlangShellInterface

@@ -88 +88 @@
 }}}
 
-You can check the already given application base directories:
+If the application has additional include directories, then these directories has to be also set in advance:
+
+{{{
+#!erlang
+ri:addenv(include, "path/to/my/incldir").
+}}}
+
+If the application build process contains compile-time macros, then these macros also can be set:
+
+{{{
+#!erlang
+%if it is only used in ifdef forms.
+ri:addenv(def, 'my_macro').
+
+ri:addenv(def, {'my_macro', my_macro_value}).
+}}}
+
+If the include forms of the application contain OS based enviromental nodes, then these nodes can be set:
+
+{{{
+#!erlang
+ri:addenv(env_var, {os_env_name, "os_env_path"}).
+}}}
+
+Let's see an example:
+
+The Emakefile has the following contents:
+{{{
+#!erlang
+
+{"/home/user/dev/lib/app1/src/*",
+   [{i,"/home/user/dev/lib/"},
+    {d,'MY_MACRO', "ITS_VALUE"},
+    {outdir,"/home/user/dev/lib/app1/ebin"}]}.
+
+{"/home/user/dev/lib/app2/src/*",
+   [{i,"/home/user/dev/lib/"},
+    {d,'MY_MACRO', "ITS_VALUE"},
+    {outdir,"/home/user/dev/lib/app2/ebin"}]}.
+
+{"/home/user/dev/lib/app3/src/*",
+   [{i,"/home/user/dev/lib/share/include/"},
+    {i,"/home/user/dev/lib/"},
+    {outdir,"/home/user/dev/lib/app3/ebin"}]}.
+}}}
+
+To add {{{app1}}}, {{{app2}}}, {{{app3}}} to !RefactorErl you should do the followings:
+{{{
+#!erlang
+
+% add app1, app2 with the same configuration
+ri:addenv(appbase, "/home/user/dev/lib/"),
+ri:addenv(def, {'MY_MACRO', "ITS_VALUE"}),
+
+Apps = [app1, app2],
+[ri:add(home, App) || App <- Apps].
+
+% add app3 after the configuration has been modified
+ri:delenv(def),
+ri:addenv(include, "/home/user/dev/lib/share/include/"),
+
+ri:add(home, app3).
+
+}}}
+
+
+You can check the already given application base directories by listing all of the enviromental nodes:
 
 {{{
@@ -95 +161 @@
 }}}
 
+It is possible to delete the defined environment variables:
+
+{{{
+#!erlang
+ri:delenv(include).
+}}}
+
+Or you can set an environmental variable to another value:
+{{{
+#!erlang
+ri:setenv(env_name, "path/to/new_value").
+}}}
+
+{{{
+#!comment
+The following enviromental nodes can be set via the {{{ri}}} module:
+
+{{{output}}}: Where does RefactorErl write changes in?
+
+{{{appbase}}}: The list of the used  application based directories.
+
+{{{include}}}: The list of the used include directories.
+
+{{{def}}}: The list of the compile-time macros.
+
+{{{env_var}}}: The list of the OS based enviromental nodes.
+
+}}}
+
+{{{
+#!comment
 Let's see an example:
 
@@ -114 +211 @@
 ...
 }}}
-
-You can also set include directories to your include files using:
-
-{{{
-#!erlang
-ri:addenv(include, "path/to/my/include").
-}}}
-
-It is possible to delete the defined environment variables:
-
-{{{
-#!erlang
-ri:delenv(include).
-}}}
-
-Or you can set an environmental variable to another value:
-{{{
-#!erlang
-ri:setenv(env_name, "path/to/new_value").
-}}}
-
+}}}
 
 For convenience, both the filenames and the directory names can be given
@@ -481 +558 @@
 
 Here's the list of supported server management commands:\\
+{{{
+#!comment
+* '''system_info()''': Returns information about the !RefactorErl System. \\
+}}}
 * '''add(FDML)''': add a module, file, directory or a list of these to the database. \\
 * '''drop(FDML)''': drop a module from the database. \\