Merge pull request modelica#2874 from HansOlsson/SourceDirExample

Source dir example
henrikt-ma · Mar 1, 2021 · 41ecf17 · 41ecf17
2 parents 6cdff14 + 30a8888
commit 41ecf17
Showing 1 changed file with 18 additions and 7 deletions.
diff --git a/chapters/functions.tex b/chapters/functions.tex
@@ -2144,7 +2144,10 @@ \subsection{Annotations for External Libraries and Include Files}\label{annotati
   external "C"
     y = ExternalFunc1_ext(x)
       annotation(Library = "ExternalLib1",
-                 Include = "#include \"ExternalFunc1.h\"");
+                 Include = "#include \"ExternalFunc1.h\"",
+                 SourceDirectory =
+                  "modelica://ExternalFunctions/Resources/Source");
+      // The SourceDirectory is the default and thus redundant.
   end ExternalFunc1;
 
   function ExternalFunc2
@@ -2175,23 +2178,31 @@ \subsection{Annotations for External Libraries and Include Files}\label{annotati
     Include        // contains the include files
       ExternalFunc1.h // C header file
       ExternalFunc2.h // C header file
-      ExternalFunc3.c // C source file
-    Library       // contains the object libraries for different
-     platforms
+      ExternalFunc3.c // C source file (not ideal)
+    Library    // contains the object libraries for different platforms
        win32
          ExternalLib1.lib // static link library for VisualStudio
          ExternalLib2.lib // statically linking the dynamic link library
          ExternalLib2.dll // dynamic link library (with manifest)
        linux32
-         libExternalLib1.a   // static link library
+         libExternalLib1.a  // static link library
          libExternalLib2.so // shared library
+    Source // Sources for library
+      Func1.c         // C source for ExternalLib1.lib
+      Func2.c         // C source for ExternalLib2.lib
+      HelperFunc.c    // C source also included in ExternalLib2.lib
 MyExternalFunctions
    package.mo
 \end{lstlisting}
-Note that calling \lstinline!MyExternalFunctions.ExternalFunc1! will use
-header and library files from \lstinline!ExternalFunction!, the \lstinline!ExternalFunctions.Example! will not use \filename{ExternalFunc3.c},
+Note that calling the function \lstinline!MyExternalFunctions.ExternalFunc1! will use
+the header and library files from \lstinline!ExternalFunction!, the \lstinline!ExternalFunctions.Example! will not use \filename{ExternalFunc3.c},
 and one library file may contain multiple functions.
 
+The C-source \filename{ExternalFunc3.c} will be included fully, and is not part of any library.
+That is not ideal for C-code, but it works for small functions.
+
+It is not specified how the C-sources in \filename{Source} will be used to build the libraries.
+
 Header file for the function in the dynamic link / shared library
 \filename{ExternalLib2} so that the desired functions are defined to be exported
 for Microsoft VisualStudio and for GNU C compiler (note, for Linux it is