Various minor changes and improvements

Author: 4ian

.gitignore

@@ -4,3 +4,6 @@ Bindings/WebIDLGrammar.pkl
 parser.out
 WebIDLGrammar.pkl
 .cpp.old
+examples/demo-generated-code.js
+examples/demo-generated-game.json
+**/.DS_Store

Bindings/Bindings.idl

@@ -385,14 +385,15 @@ interface InitialInstance {
 interface InitialInstancesContainer {
     void InitialInstancesContainer();
 
-    long GetInstancesCount();
+    unsigned long GetInstancesCount();
 
     void IterateOverInstances([Ref] InitialInstanceFunctor func);
     void IterateOverInstancesWithZOrdering([Ref] InitialInstanceFunctor func, [Const] DOMString layer);
     void MoveInstancesToLayer([Const] DOMString fromLayer, [Const] DOMString toLayer);
     void RemoveAllInstancesOnLayer([Const] DOMString layer);
     void RemoveInitialInstancesOfObject([Const] DOMString obj);
-    void SomeInstancesAreOnLayer([Const] DOMString layer);
+    boolean SomeInstancesAreOnLayer([Const] DOMString layer);
+    void RenameInstancesOfObject([Const] DOMString oldName, [Const] DOMString newName);
     void RemoveInstance([Const, Ref] InitialInstance inst);
 
     [Ref] InitialInstance InsertNewInitialInstance();

Bindings/glue.cpp

@@ -2354,7 +2354,7 @@ InitialInstancesContainer* EMSCRIPTEN_KEEPALIVE emscripten_bind_InitialInstances
   return new InitialInstancesContainer();
 }
 
-int EMSCRIPTEN_KEEPALIVE emscripten_bind_InitialInstancesContainer_GetInstancesCount_0(InitialInstancesContainer* self) {
+unsigned int EMSCRIPTEN_KEEPALIVE emscripten_bind_InitialInstancesContainer_GetInstancesCount_0(InitialInstancesContainer* self) {
   return self->GetInstancesCount();
 }
 
@@ -2378,8 +2378,12 @@ void EMSCRIPTEN_KEEPALIVE emscripten_bind_InitialInstancesContainer_RemoveInitia
   self->RemoveInitialInstancesOfObject(arg0);
 }
 
-void EMSCRIPTEN_KEEPALIVE emscripten_bind_InitialInstancesContainer_SomeInstancesAreOnLayer_1(InitialInstancesContainer* self, char* arg0) {
-  self->SomeInstancesAreOnLayer(arg0);
+bool EMSCRIPTEN_KEEPALIVE emscripten_bind_InitialInstancesContainer_SomeInstancesAreOnLayer_1(InitialInstancesContainer* self, char* arg0) {
+  return self->SomeInstancesAreOnLayer(arg0);
+}
+
+void EMSCRIPTEN_KEEPALIVE emscripten_bind_InitialInstancesContainer_RenameInstancesOfObject_2(InitialInstancesContainer* self, char* arg0, char* arg1) {
+  self->RenameInstancesOfObject(arg0, arg1);
 }
 
 void EMSCRIPTEN_KEEPALIVE emscripten_bind_InitialInstancesContainer_RemoveInstance_1(InitialInstancesContainer* self, InitialInstance* arg0) {

Bindings/glue.js

@@ -3843,7 +3843,16 @@ InitialInstancesContainer.prototype['SomeInstancesAreOnLayer'] = function(arg0)
   var self = this.ptr;
   if (arg0 && typeof arg0 === 'object') arg0 = arg0.ptr;
   else arg0 = ensureString(arg0);
-  _emscripten_bind_InitialInstancesContainer_SomeInstancesAreOnLayer_1(self, arg0);
+  return !!(_emscripten_bind_InitialInstancesContainer_SomeInstancesAreOnLayer_1(self, arg0));
+};;
+
+InitialInstancesContainer.prototype['RenameInstancesOfObject'] = function(arg0, arg1) {
+  var self = this.ptr;
+  if (arg0 && typeof arg0 === 'object') arg0 = arg0.ptr;
+  else arg0 = ensureString(arg0);
+  if (arg1 && typeof arg1 === 'object') arg1 = arg1.ptr;
+  else arg1 = ensureString(arg1);
+  _emscripten_bind_InitialInstancesContainer_RenameInstancesOfObject_2(self, arg0, arg1);
 };;
 
 InitialInstancesContainer.prototype['RemoveInstance'] = function(arg0) {

Gruntfile.js

@@ -28,6 +28,24 @@ module.exports = function(grunt) {
             dest: buildOutputPath+'libGD.js',
           },
         },
+        //Patch SFML to consider Emscripten target as Linux.
+        'string-replace': {
+          sfml: {
+            files: {
+              '../ExtLibs/SFML/include/SFML/Config.hpp': '../ExtLibs/SFML/include/SFML/Config.hpp',
+            },
+            options: {
+              replacements: [
+                // place files inline example
+                {
+                  pattern: "#elif defined(__linux__)",
+                  replacement: "#elif defined(EMSCRIPTEN) || defined(__linux__)"
+                }
+              ],
+              saveUnchanged: false
+            }
+          }
+        },
         mkdir: {
           embuild: {
             options: {
@@ -47,7 +65,7 @@ module.exports = function(grunt) {
                     }
                 }
             },
-            //Update glue.cpp and glue.js file using Bindings.idl
+            //Generate glue.cpp and glue.js file using Bindings.idl, and patch them
             updateGDBindings: {
                 src: "Bindings/Bindings.idl",
                 command: 'node update-bindings.js',
@@ -94,11 +112,13 @@ module.exports = function(grunt) {
     grunt.loadNpmTasks('grunt-contrib-concat');
     grunt.loadNpmTasks('grunt-contrib-uglify');
     grunt.loadNpmTasks('grunt-contrib-compress');
+    grunt.loadNpmTasks('grunt-string-replace');
     grunt.loadNpmTasks('grunt-shell');
     grunt.loadNpmTasks('grunt-newer');
     grunt.loadNpmTasks('grunt-mkdir');
     grunt.registerTask('build', [
       'clean',
+      'string-replace:sfml',
       'mkdir:embuild',
       'newer:shell:cmake',
       'newer:shell:updateGDBindings',

Readme.md

@@ -1,36 +1,49 @@
 libGD.js
 ========
 
-This is a port of some parts of [GDevelop] to Javascript using [Emscripten].
+This is a port of some parts of **[GDevelop]** to Javascript using **[Emscripten]**.
 
 GDevelop is a full featured, cross-platform, open-source game creator software requiring no programming skills. Download it on [the official website](http://compilgames.net) and check its [GitHub page](https://github.com/4ian/GD).
 
+This module is used to power [GDevApp], a radically innovative game creator that can be used by anyone to create games directly from a desktop or tablet web browser.
+
 How to build
 ------------
 
 Make sure you have [CMake](http://www.cmake.org/) and [Emscripten](https://github.com/kripken/emscripten) installed (your OS package manager should be able to provide both). You need Emscripten 1.33.1 at least to avoid [this bug](https://github.com/kripken/emscripten/pull/3479).
 
-* Clone [GDevelop repository](https://github.com/4ian/GD) and this repository at the root of GD
+* Clone [GDevelop repository](https://github.com/4ian/GD) and this repository at the root of GD repository:
 
 ```shell
-        git clone https://github.com/4ian/GD.git
-        cd GD && git clone https://github.com/4ian/libGD.js.git
+    git clone https://github.com/4ian/GD.git
+    cd GD && git clone https://github.com/4ian/libGD.js.git
 ```
 
-* Patch SFML (TODO)
-* Patch WebIDL binder (TODO)
-* Launch grunt
+* Patch WebIDL binder to support returning javascript boolean. Go to path/to/emscripten/tools/webidl_binder.py, search for
 
-```shell
-        grunt shell:cmake #The first time only
-        grunt build
+```python
+    elif return_type == 'String':
+      call_prefix += 'Pointer_stringify('
+      call_postfix += ')'
 ```
 
-### Internal steps for compilation
+and add just after:
 
-Internally, the grunt build task create `Binaries/embuild` directory, launch CMake inside to compile GDevelop with *Emscripten toolchain file*, update the glue.cpp and glue.js from Bindings.idl using *Emscripten WebIDL Binder*, launch the compilation with *make* and wrap the generated `libGD.js.raw` into the final `libGD.js` file.
+```python
+    elif return_type == 'Boolean':
+      call_prefix += '!!('
+      call_postfix += ')'
+```
 
-It also create a compressed `libGD.js.gz` file which is handy for distributing the library pre-compressed to web browsers.
+* Launch the build:
+
+```shell
+    cd libGD.js
+    grunt shell:cmake #The first time only
+    grunt build
+```
+
+Output is created in */path/to/GD/Binaries/Output/libGD.js/*.
 
 Launch tests and examples
 -------------------------
@@ -39,5 +52,35 @@ Launch tests with grunt:
 
     grunt test
 
+Or launch example:
+
+    cd examples && node demo.js
+
+The demo generate a json file that can be opened with [GDevelop] or [GDevApp]!
+
+### About the internal steps of compilation
+
+The grunt *build* task:
+
+ * create `Binaries/embuild` directory, 
+ * patch SFML `Config.hpp` file to make Emscripten recognized as a linux target,
+ * launch CMake inside to compile GDevelop with *Emscripten toolchain file*, 
+ * update the glue.cpp and glue.js from Bindings.idl using *Emscripten WebIDL Binder*, 
+ * launch the compilation with *make* and wrap the generated `libGD.js.raw` into the final `libGD.js` file.
+
+It also create a compressed `libGD.js.gz` file which is handy for distributing the library pre-compressed to web browsers.
+
+Documentation
+-------------
+
+Refer to [GDevelop documentation](http://4ian.github.io/GD-Documentation/GDCore%20Documentation/) for detailed documentation of the original C++ classes. The file Bindings.idl describes all the classes available in libGD.js.
+
+License
+-------
+
+* This library is distributed under the **MIT license**.
+* GDevelop is under the MIT license (and GPL v3 license for the GUI).
+
 [GDevelop]: https://github.com/4ian/GD
+[GDevApp]: https://gdevapp.com
 [Emscripten]: https://github.com/kripken/emscripten

examples/demo.js

@@ -1,7 +1,5 @@
 /**
- * Run this file using node.js. Be sure to paste libGD.js in the same folder:
- *
- * node demo.js
+ * Example of various manipulations using libGD.js
  */
 
 var gd = require('../../Binaries/Output/libGD.js/Release/libGD.js');
@@ -18,7 +16,6 @@ console.log(" ");
 var project = gd.ProjectHelper.createNewGDJSProject(); //The project is based on the Javascript platform
 project.setMinimumFPS(20);
 project.setMaximumFPS(20);
-project.customValue = 54;
 project.getVariables().insertNew("Global variable", 0).setValue(10);
 var layout = project.insertNewLayout("Super scene", 0); //"Layout" is a synonym for "Scene".
 layout.setBackgroundColor(125,100,240);
@@ -32,7 +29,7 @@ layout.insertNewObject(project, "Sprite", "MyCharacter", 0);
 var obj = layout.getObject("MyObject");
 obj.setName("Background");
 
-//Adding an animation to a sprite:
+//Add an animation to a sprite:
 var anim = new gd.Animation();
 anim.setDirectionsCount(2);
 gd.asSpriteObject(obj).addAnimation(anim);
@@ -77,12 +74,12 @@ console.log("*** Events displayed as english sentences (Just like in the events
 
 var condition = standardEvt.getConditions().get(0);
 var conditionSentenceInEnglish = gd.InstructionSentenceFormatter.get().translate(condition,
-	gd.MetadataProvider.getConditionMetadata(gd.JsPlatform.get(), "KeyPressed"));
+    gd.MetadataProvider.getConditionMetadata(gd.JsPlatform.get(), "KeyPressed"));
 console.log("Condition:", conditionSentenceInEnglish);
 
 var action = standardEvt.getActions().get(0);
 var actionSentenceInEnglish = gd.InstructionSentenceFormatter.get().translate(action,
-	gd.MetadataProvider.getActionMetadata(gd.JsPlatform.get(), "Delete"));
+    gd.MetadataProvider.getActionMetadata(gd.JsPlatform.get(), "Delete"));
 console.log("Action:", actionSentenceInEnglish);
 
 //Do automatic refactoring on the events:
@@ -91,42 +88,35 @@ console.log("Action:", actionSentenceInEnglish);
 layout.getObject("MyCharacter").setName("MySuperHero"); //Change the object name...
 instances.renameInstancesOfObject("MyCharacter", "MySuperHero"); //...update the instances on the scene...
 gd.EventsRefactorer.renameObjectInEvents(gd.JsPlatform.get(), project,
-	layout, layout.getEvents(), "MyCharacter", "MySuperHero"); //...and update the events.
+    layout, layout.getEvents(), "MyCharacter", "MySuperHero"); //...and update the events.
 
 console.log("*** The action after renaming MyCharacter to MySuperHero:");
 var actionSentenceInEnglish = gd.InstructionSentenceFormatter.get().translate(standardEvt.getActions().get(0),
-	gd.MetadataProvider.getActionMetadata(gd.JsPlatform.get(), "Delete"));
+    gd.MetadataProvider.getActionMetadata(gd.JsPlatform.get(), "Delete"));
 console.log("Action:", actionSentenceInEnglish);
 
 //Finally, write the game to a file.
 var serializedProject = new gd.SerializerElement();
 project.serializeTo(serializedProject);
 var jsonProject = gd.Serializer.toJSON(serializedProject);
 fs.writeFile('demo-generated-game.json', jsonProject, function (err) {
-  if (err) throw err;
-  console.log('*** JSON file of the generated project saved in "demo-generated-game.json". Open it!');
-
-	var unserializedProject = new gd.SerializerElement();
-	unserializedProject = gd.Serializer.fromJSON(jsonProject);
-	project.unserializeFrom(unserializedProject);
-
-	var serializedProject = new gd.SerializerElement();
-	project.serializeTo(serializedProject);
-	var jsonProject = gd.Serializer.toJSON(serializedProject);
-	fs.writeFile('demo-generated-game2.json', jsonProject, function (err) {
-		if (err) throw err;
-		console.log('*** JSON file of the generated project saved in "demo-generated-game2.json". Open it!');
-	});
+    if (err) throw err;
+    console.log('*** JSON file of the generated project saved in "demo-generated-game.json". Open it with GDevelop or GDevApp!');
+
+    var project = new gd.ProjectHelper.createNewGDJSProject();
+    var unserializedProject = gd.Serializer.fromJSON(jsonProject);
+    project.unserializeFrom(unserializedProject);
 });
 
 //And also generate the code for the events to demonstrate how events are translated to Javascript!
-var code = gd.GenerateSceneEventsCompleteCode(project, layout, layout.getEvents(), new gd.SetString(), true);
+var code = gd.EventsCodeGenerator.generateSceneEventsCompleteCode(project,
+    layout, layout.getEvents(), new gd.SetString(), true);
 fs.writeFile('demo-generated-code.js', code, function (err) {
   if (err) throw err;
-  console.log('*** Javascript code saved in "demo-generated-code.js". Open it (but it\'s not meant to be read by humans) !');
+  console.log('*** Javascript code saved in "demo-generated-code.js". You can open it, but it\'s not meant to be read by humans! ;)');
 });
 
-//Note that any object from gd created using new operator ("var myObject = new gd.")
+//Note that any object from gd created using new operator ("var myObject = new gd.*")
 //must be deleted. Most of the time, it is not necessary to use new because there are methods for
-//creating the objects (InsertLayout, InsertNewObject...) and everything is contained in the project object:
+//creating the objects (insertLayout, insertNewObject...) and everything is contained in the project object:
 project.delete();

package.json

@@ -27,6 +27,7 @@
     "grunt-mocha-cli": "~1.8.0",
     "grunt-newer": "^1.1.0",
     "grunt-shell": "^1.1.2",
+    "grunt-string-replace": "^1.2.0",
     "mocha": "~1.18.2"
   }
 }