Dev standalone

.gitignore

@@ -12,7 +12,6 @@ userPreferences.*/
 
 # Other
 Project/Trash
-Settings/buildApp.4DSettings
 
 # System files
 .DS_Store
@@ -23,8 +22,11 @@ Thumbs.db
 *.4dbase/
 UT_*.log
 Build_*.log
+*.license4D
 Artifacts/
-Test/
-Build/
-Build4D_UnitTests_Build/
-Build4D_External_Build/
+zzz*.4dm
+
+# Build
+*Test/
+*Build/
+*buildApp.4DSettings

Build4D/Documentation/Classes/CompiledProject.md

@@ -1,7 +1,7 @@
 <!-- Type your summary here -->
 ## Description
 
-This class allows you to create a compiled project. It is composed of:
+This class allows you to create a compiled project. It is composed of the following:
 
 * a [Class constructor](#class-constructor)
 * a [build()](#build) function
@@ -13,22 +13,22 @@ Class constructor($customSettings : Object)
 ```
 | Parameter | Type | in/out | Description |
 |---|---|---|---|
-| $customSettings | Object | in | $customSettings is a custom settings object overriding target default settings stored in "/RESOURCES/CompiledProject.json" file |
+| $customSettings | Object | in | $customSettings is a custom settings object overriding target default settings stored in the "/RESOURCES/CompiledProject.json" file. |
 
 $customSettings is an object that contains the following parameters:
 
 | Attributes | Type | Description |
 |---|---|---|        
-|buildName | String | Name of the target build. Defined by the component if missing in the custom settings.|
-|projectFile | File or String | Project file. Pass the project file path if you want to build an external project. Not necessary if it is a current project.|
-|destinationFolder | Folder or String | Folder where the build will be generated. Defined by the component if missing in the custom settings.|
-|compilerOptions | Object | Compile options. The object is passed as parameter to the "Compile project" command if is not null.|
+|buildName | String | Name of the target build, defined by the component if missing in the custom settings.|
+|projectFile | File or String | Project file (relative to the open project/absolute/filesystem). Pass the project file path if you want to build an external project (not necessary if building the current project).|
+|destinationFolder | Folder or String | Folder where the build will be generated (relative to the open project/absolute/filesystem), defined by the component if missing in the custom settings.|
+|compilerOptions | Object | Compile options. The object is passed as parameter to the "Compile project" command if it is not null. For more details about the object format, read the documentation of the Compile project command.|
 |packedProject | Boolean | True if the project is compressed into a 4DZ file.|
-|obfuscated | Boolean | True if the 4DZ shall not be dezippable.|
+|obfuscated | Boolean | True if the 4DZ is to not be dezippable.|
 |includePaths[] | Collection of Objects | Collection of folders and files to include.|
-|includePaths[].source | String | Source folder or file path (relative to the built project/absolute/filesystem strings).|
-|includePaths[].destination | String | Destination folder path (relative to the built project/absolute/filesystem strings).|
-|deletePaths[] | Collection of Strings | Collection of paths to folders and files to be deleted (relative to the built project/absolute/filesystem strings).|
+|includePaths[].source | Folder, File, or String | Source folder or file path (relative to the open project/absolute/filesystem strings).|
+|includePaths[].destination | Folder, File, or String | Destination folder path (relative to the built project/absolute/filesystem).|
+|deletePaths[] | Collection of Folders, Files, or Strings | Collection of paths to folders and files to be deleted (relative to the built project/absolute/filesystem).|
 |logger | Formula | Formula called when a log is written.|
 
 ### build()
@@ -38,7 +38,7 @@ Function build() -> $status : Boolean
 ```
 | Parameter | Type | in/out | Description |
 |---|---|---|---|
-| $status | Boolean | out | True if the build has been correctly executed |
+| $status | Boolean | out | True if the build has been correctly executed. |
 
 Builds the compiled project.
 

Build4D/Documentation/Classes/Component.md

@@ -1,7 +1,7 @@
 <!-- Type your summary here -->
 ## Description
 
-This class allows you to create a component. It is composed of:
+This class allows you to create a component. It is composed of the following:
 
 * a [Class constructor](#class-constructor)
 * a [build()](#build) function
@@ -13,22 +13,22 @@ Class constructor($customSettings : Object)
 ```
 | Parameter | Type | in/out | Description |
 |---|---|---|---|
-| $customSettings | Object | in | $customSettings is a custom settings object overriding target default settings stored in "/RESOURCES/Component.json" file |
+| $customSettings | Object | in | $customSettings is a custom settings object overriding target default settings stored in the "/RESOURCES/Component.json" file. |
 
 $customSettings is an object that contains the following parameters:
 
 | Attributes | Type | Description |
 |---|---|---|        
-|buildName | String | Name of the target build. Defined by the component if missing in the custom settings.|
-|projectFile | File or String | Project file. Pass the project file path if you want to build an external project. Not necessary if it is a current project.|
-|destinationFolder | Folder or String | Folder where the build will be generated. Defined by the component if missing in the custom settings.|
-|compilerOptions | Object | Compile options. The object is passed as parameter to the "Compile project" command if is not null.|
+|buildName | String | Name of the target build, defined by the component if missing in the custom settings.|
+|projectFile | File or String | Project file (relative to the open project/absolute/filesystem). Pass the project file path if you want to build an external project (not necessary if building the current project=.|
+|destinationFolder | Folder or String | Folder where the build will be generated (relative to the open project/absolute/filesystem), defined by the component if missing in the custom settings.|
+|compilerOptions | Object | Compile options. The object is passed as parameter to the "Compile project" command if it is not null. For more details about the object format, read the documentation of the Compile project command.|
 |packedProject | Boolean | True if the project is compressed into a 4DZ file.|
-|obfuscated | Boolean | True if the 4DZ shall not be dezippable.|
+|obfuscated | Boolean | True if the 4DZ is to not be dezippable.|
 |includePaths[] | Collection of Objects | Collection of folders and files to include.|
-|includePaths[].source | String | Source folder or file path (relative to the built project/absolute/filesystem strings).|
-|includePaths[].destination | String | Destination folder path (relative to the built project/absolute/filesystem strings).|
-|deletePaths[] | Collection of Strings | Collection of paths to folders and files to be deleted (relative to the built project/absolute/filesystem strings).|
+|includePaths[].source | Folder, File, or String | Source folder or file path (relative to the open project/absolute/filesystem).|
+|includePaths[].destination | Folder, File, or String | Destination folder or file path (relative to the built project/absolute/filesystem).|
+|deletePaths[] | Collection of Folders, Files, or Strings | Collection of paths to folders and files to be deleted (relative to the built project/absolute/filesystem strings).|
 |signApplication.macSignature | Boolean | Signs the built applications.|
 |signApplication.macCertificate | String | Certificate name used  for signature.|
 |signApplication.adHocSignature | Boolean | Signs the built applications with AdHoc signature if macSignature not performed.|
@@ -41,7 +41,7 @@ Function build() -> $status : Boolean
 ```
 | Parameter | Type | in/out | Description |
 |---|---|---|---|
-| $status | Boolean | out | True if the build has been correctly executed|
+| $status | Boolean | out | True if the build has been correctly executed.|
 
 Build the component.
 

Build4D/Documentation/Classes/Standalone.md

@@ -0,0 +1,137 @@
+<!-- Type your summary here -->
+## Description
+
+This class allows you to create a standalone application. It is composed of the following:
+
+* a [Class constructor](#class-constructor)
+* a [\_renameExecutable](#renameExecutable) function
+* a [build()](#build) function
+
+### Class constructor
+
+```4D
+Class constructor($customSettings : Object)
+```
+| Parameter | Type | in/out | Description |
+|---|---|---|---|
+| $customSettings | Object | in | $customSettings is a custom settings object overriding target default settings stored in the "/RESOURCES/Standalone.json" file. |
+
+$customSettings is an object that contains the following parameters:
+
+| Attributes | Type | Description |
+|---|---|---|        
+|buildName | String | Name of the target build, defined by the component if missing in the custom settings.|
+|projectFile | File or String | Project file (relative to the open project/absolute/filesystem). Pass the project file path if you want to build an external project (not necessary if building the current project).|
+|destinationFolder | Folder or String | Folder where the build will be generated (relative to the open project/absolute/filesystem), defined by the component if missing in the custom settings.|
+|sourceAppFolder| Folder or String | Folder of the 4D Volume Desktop (relative to the open project/absolute/filesystem).|
+|compilerOptions | Object | Compile options. The object is passed as parameter to the "Compile project" command if it is not null. For more details about the object format, read the documentation of the Compile project command.|
+|packedProject | Boolean | True if the project is compressed into a 4DZ file.|
+|obfuscated | Boolean | True if the 4DZ is to not be dezippable.|
+|lastDataPathLookup| String | Defines the way the application stores its link with the last data file. Possible values: "ByAppName" (Default value) and "ByAppPath".|
+|useSDI| Boolean | Allows to use the SDI interface mode instead of the MDI (Windows only).|
+|startElevated| Boolean | Allows to start the Updater with elevated privileges (Windows only).|
+|iconPath| File or String | File path of the icon to be used instead of the 4D Volume Desktop icon.|
+|versioning| Object | Object containing the contents of the application information.|
+|versioning.version| String | Version number. |
+|versioning.copyright| String | Copyright text. |
+|versioning.companyName| String | Company name. |
+|versioning.fileDescription| String | Description (Windows only).|
+|versioning.internalName| String | Internal name (Windows only).|
+|includePaths[] | Collection of Objects | Collection of folders and files to include.|
+|includePaths[].source | Folder, File, or String | Source folder or file path (relative to the open project/absolute/filesystem).|
+|includePaths[].destination | Folder, File, or String | Destination folder path (relative to the built project/absolute/filesystem).|
+|deletePaths[] | Collection of Folder, File, or Strings | Collection of paths to folders and files to be deleted (relative to the built project/absolute/filesystem strings).|
+|excludeModules| Collection of Strings | Collection of module names to exclude from final application. The module names can be found in the "BuildappOptionalModules.json" file in the resources of the 4D application.|
+|license| File or String | Unlimited desktop license file (relative to the built project/absolute/filesystem).|
+|signApplication.macSignature | Boolean | Signs the built applications.|
+|signApplication.macCertificate | String | Certificate name used for signature.|
+|signApplication.adHocSignature | Boolean | Signs the built applications with AdHoc signature if macSignature not performed.|
+|logger | Formula | Formula called when a log is written.|
+
+<h3 id="renameExecutable">_renameExecutable</h3>
+
+```4D
+Function _renameExecutable() -> $status : Boolean
+```
+| Parameter | Type | in/out | Description |
+|---|---|---|---|
+| $status | Boolean | out | True if the executable has been correctly renamed. |
+
+Renames the executable.
+
+### build()
+
+```4D
+Function build() -> $status : Boolean
+```
+| Parameter | Type | in/out | Description |
+|---|---|---|---|
+| $status | Boolean | out | True if the standalone has been correctly executed.|
+
+Builds the standalone application.
+
+## Example
+
+This code is an example to generate a standalone application from an external project.
+
+```4D
+var $build : cs.Build4D.Standalone
+var $settings : Object
+var $success : Boolean
+
+$settings:={}
+
+// Define the external project file 
+$settings.projectFile:=Folder(fk documents folder).file("Contact/Project/Contact.4DProject") 
+
+// Configure the application
+$settings.buildName:="myApp" 
+$settings.destinationFolder:="Test/" 
+$settings.obfuscated:=True 
+$settings.packedProject:=True 
+$settings.useSDI:=False 
+$settings.startElevated:=False 
+$settings.lastDataPathLookup:="ByAppPath"
+
+// Specify the components required for compilation
+$componentsFolder:=Folder(fk documents folder).folder("4D v20.0/4D.app/Contents/Components")
+$components:=[]
+$components.push($componentsFolder.file("4D WritePro Interface.4dbase/4D WritePro Interface.4DZ"))
+$settings.compilerOptions:={components: $components}
+
+// Define the 4D Volume Desktop path
+$settings.sourceAppFolder:=Folder(fk documents folder).folder("4D v20.0/4D Volume Desktop.app")
+
+// Delete the unnecessary module 
+$settings.excludeModules:=["CEF"; "MeCab"]
+
+// Include the folders and files
+$settings.includePaths:=[] 
+$settings.includePaths.push({source: $componentsFolder.folder("4D WritePro Interface.4dbase").path; destination: "../Components/"})
+$settings.includePaths.push({source: $componentsFolder.folder("4D SVG.4dbase").path; destination: "../Components/"})
+
+// Delete the folders and files 
+$settings.deletePaths:=[] 
+$settings.deletePaths.push("Resources/Dev/")
+
+// Add the application icon 
+$settings.iconPath:="/RESOURCES/myIcon.icns"
+
+// Add the application information 
+$settings.versioning:={} 
+$settings.versioning.version:="version" 
+$settings.versioning.copyright:="copyright" 
+$settings.versioning.companyName:="companyName" 
+
+// Create the deployment license file
+$settings.license:=Folder(fk licenses folder).file("XXXXX.license4D")
+
+// Sign the macOS appplication 
+$settings.signApplication:={} 
+$settings.signApplication.macSignature:=True 
+$settings.signApplication.macCertificate:="xxxxxx"
+
+// Launch the build
+$build:=cs.Build4D.Standalone.new($settings) 
+$success:=$build.build()
+```