easy-swig 1.0 → 1.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDNkNmY2ZmU4YTlkM2Y1YTFmYTA0ZWE2NTc3MmE3NWQ0ZjRhMmE5Yg==
+    MWJjYTI1Y2Q1Zjg5ZjhmZDcwZmM4OTY4ZDdlZDRhNGFkZjkzYTc4OQ==
   data.tar.gz: !binary |-
-    ODE0YmIxYTM1MGU5NTU1YzQ5ZjcwMzliMDBkNjk5ZDY3ZjA5ZmQ5OQ==
+    YWYyMThiYTg5NmEyZjczMmNmMjZmYjE5NTU3NzQ4OTRkZDJiMjQ0OQ==
 SHA512:
   metadata.gz: !binary |-
-    M2E2NDljMzMxZThlZWQ1YzdkYTE5OGJjZGExOTE0ODMxOTc0MjU3Mjc3NTdl
-    MGRmZDE2N2UyY2E5OTM5OWMxNzYwYzU3OWE5YmFkZTliYTE0ZTE4YzIyNmRi
-    N2QyMTQ2NGEwZDU1OGIxOWZlMTExMmJlMDFmZjA5YmVkYmRlMDM=
+    NmI1ZTgwOTgxZGViNzc3MTFkYTkwZWI5NzUwMDYzNjYzMDJmMzYwMTZhY2Rk
+    MjhjYzcwMmIzODM3YTdiNWRlMDhkYjEyMDBhMjVmMzhkYzVmM2ZhNTUyZGJj
+    NGNiNzhhZjJhMGE0MGE5ZDIzNzQyNjdlYjFkYmE4NjAwYTRkNzA=
   data.tar.gz: !binary |-
-    OWQwZWQ2MTVmZTFhMWJhNDZmY2NiYzdlY2NhNDBhN2VkYzU0MzMzMWI1ZmJk
-    OGJiODFjMzIwOWI2NTE4YjZmMGY1NTliNWVlZTBkZDAyMTNlZDMzNWMzNjIy
-    MTQ1YjUzZDU2YWNjNzY0NDBmOGZhZTBmOTRhODA5MzUzOGE0MjE=
+    OGNiMzc2NzZhNjNiMGJmNTEzOTU4MzgyZGM3ZTZkZDBmMTYzYzgxMTVhMTFl
+    NzkxMDcxMDFhZTU2MTIyMjY2NDZmYmE3MDNhZmFkZTllZmZlNmM3Njg4OGQ3
+    NTE2ZThiMGY5NWI0NGU3NjNkMzZhYWI3YTdlZWRhNWNkYzU2MDg=

data/README.md

@@ -13,14 +13,14 @@ Installation and Use
 
 EasySwig relies on the Doxyparser gem (https://github.com/davfuenmayor/ruby-doxygen-parser) which on his part depends on Nokogiri (http://nokogiri.org) and Doxygen (www.doxygen.org). Refer to Doxyparser for more information.
 
-To actually generate wrappers you may also want to install SWIG (http://www.swig.org/). Currently only SWIG version 2.0.11 is supported. There is  ongoing work on 3.0.0 version support.
+To actually generate wrappers you may also want to install SWIG (http://www.swig.org/). SWIG versions 2.x and 3.x are supported.
 
 
 For using EasySwig you need to create a folder with the following structure:
 (it is recommended to use the subfolder 'spec/Example' as a template)
 
 - A subfolder named 'include' with the header files you want to wrap.
-- A CSV file named 'api.csv' with the name of the namespace you want to wrap and which classes to wrap/ignore.
+- A CSV file named 'api.csv' with the name of the namespace you want to wrap and which members to wrap/ignore. See below.
 - An optional file (optionally named custom_config.i) with %include statements for those header files found in subdirectories (otherwise SWIG won't find them)
 
 There are three operations you can do with EasySwig: 'doxygen', 'generate' and 'swig'
@@ -62,25 +62,106 @@ Or with some configuration:
 	EasySwig::swig(config)
 ```
 
-You can consult the documentation (generated with YARD) in doc/ subfolder for more information about the EasySwig::Config class and its default values.
+You can consult the documentation (generated with YARD: yard doc) in doc/ subfolder for more information about the EasySwig::Config class and its default values.
 
 
 As CLI
 ----------
 
-Download (or clone) this repository. An illustrative example of how to use EasySwig as CLI-Tool is found in subfolder spec/Example.
+Download (or clone) this repository. An illustrative example of how to use EasySwig as CLI-Tool is found in subfolder Example/
 Open the corresponding README file and follow the instructions. This Example project can also be used as template for your own wrappers.
 
 ```shell
-cd spec/Example
+cd Example
 # Displays command help. Useful for parameter syntax, options and default values
-sh ../../bin/easyswig.sh -h
+sh ../bin/easyswig.sh -h
 # Generate Doxygen XML Intermediate representation. Found in generated subfolder: 'easy-swig/doxygen'
-sh ../../bin/easyswig.sh doxygen
+sh ../bin/easyswig.sh doxygen
 # Generate SWIG Interface Files (.i). Found in generated subfolder: 'easy-swig/generate'
-sh ../../bin/easyswig.sh generate
+sh ../bin/easyswig.sh generate
 # Generate Wrappers using your installed version of SWIG. Found in generated subfolder: 'easy-swig/swig'
-sh ../../bin/easyswig.sh swig
+sh ../bin/easyswig.sh swig
 ```
 
+Selecting which members to wrap (namespaces/classes/functions/variables...)
+----------------------
+
+EasySwig allows you to cherry-oick which members of a namespace to wrap and also offers some simple configuration. For this we make use of a CSV file
+with following contents:
+
+#namespace
+
+target_name: Desired name of the Namespace in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ namespace. If empty, 'target_name' will be used
+wrap_classes: Every class/struct in this namespace will be wrapped
+wrap_functions: Every function outside any struct/class in this namespace will be wrapped
+wrap_enums: Every enum outside any struct/class in this namespace will be wrapped
+wrap_variables: Every variable outside any struct/class in this namespace will be wrapped
+friend_support: Support for friend members will be active by default for all structs/classes inside this namespace
+properties: Support for (C#) properties will be active by default for all structs/classes inside this namespace
+partial: Every wrapper for structs/classes inside this namespace will be generated with the 'partial' C# keyword
+nested_support: Support for Innerclasses when using SWIG 2.x (Unnecessary for versions newer than 3.0)
+
+#function
+
+target_name: Desired name of the function (relative to the given namespace) in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ function (relative to the given namespace). If empty, 'target_name' will be used
+ignore: This member will be ignored. Useful in case it has been indirectly included by checking any of the parent's 'wrap_xxx' flags
+
+#variable
+
+target_name: Desired name of the global variable (relative to the given namespace) in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ global variable (relative to the given namespace). If empty, 'target_name' will be used
+ignore: This member will be ignored. Useful in case it has been indirectly included by checking any of the parent's 'wrap_xxx' flags
+
+#enum
+
+target_name: Desired name of the enum (relative to the given namespace) in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ enum (relative to the given namespace). If empty, 'target_name' will be used
+ignore: This member will be ignored. Useful in case it has been indirectly included by checking any of the parent's 'wrap_xxx' flags
+
+#class
+
+target_name: Desired name of the class/struct (relative to the given namespace) in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ class/struct (relative to the given namespace). If empty, 'target_name' will be used
+ignore: This member will be ignored. Useful in case it has been indirectly included by checking any of the parent's 'wrap_xxx' flags
+wrap_innerclasses: Every innerclass/innerstruct defined inside this class/struct will be wrapped
+wrap_methods: Every method of this class/struct will be wrapped
+wrap_enums: Every enum defined inside this class/struct will be wrapped
+wrap_attributes: Every attribute of this class/struct will be wrapped
+friend_support: Support for friend members is active
+properties: Support for generating (C#) properties will be active by default for every getter/setter method defined in this class/struct
+partial: Class will be generated with the 'partial' C# keyword
+struct: Struct will be mapped as such in the target language (only C# - not yet supported )
+nested_support: Support for Innerclasses when using SWIG 2.x (Unnecessary for versions newer than 3.0)
+
+#method
+
+target_name: Desired name of the method (relative to the last given class/struct) in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ method (relative to the last given class/struct). If empty, 'target_name' will be used
+ignore: This member will be ignored. Useful in case it has been indirectly included by checking any of the parent's 'wrap_xxx' flags
+properties: If this method is a getter/setter, a cooresponding property will be generated in the target language (C#)
+
+#attribute
+
+target_name: Desired name of the attribute (relative to the last given class/struct) in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ attribute (relative to the last given class/struct). If empty, 'target_name' will be used
+ignore: This member will be ignored. Useful in case it has been indirectly included by checking any of the parent's 'wrap_xxx' flags
+
+#innerenum
+
+target_name: Desired name of the enum (relative to the last given class/struct) in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ enum (relative to the last given class/struct). If empty, 'target_name' will be used
+ignore: This member will be ignored. Useful in case it has been indirectly included by checking any of the parent's 'wrap_xxx' flags
+
+#innerclass
+
+target_name: Desired name of the innerclass (relative to the last given class/struct) in the Target Language (C#). If empty, 'basename' will be used
+basename: Name of the C/C++ innerclass (relative to the last given class/struct). If empty, 'target_name' will be used
+ignore: This member will be ignored. Useful in case it has been indirectly included by checking any of the parent's 'wrap_xxx' flags
+friend_support: Support for friend members is active
+properties: Support for generating (C#) properties will be active by default for every getter/setter method defined in this class/struct
+struct: Structs will be mapped as such in the target language (only C# - not yet supported )
+nested_support: Support for Innerclasses when using SWIG 2.x (Unnecessary for versions newer than 3.0)
+
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy-swig
 version: !ruby/object:Gem::Version
-  version: '1.0'
+  version: '1.1'
 platform: ruby
 authors:
 - David Fuenmayor
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-02 00:00:00.000000000 Z
+date: 2014-05-10 00:00:00.000000000 Z
 dependencies: []
 description: ! "  \nLibrary and CLI-Tool for automatic generation wrappers for C/C++
   code using SWIG.\nThis is both a Ruby Gem and a CLI Tool. Feed it with a directory
@@ -19,9 +19,8 @@ description: ! "  \nLibrary and CLI-Tool for automatic generation wrappers for C
   relies on the Doxyparser gem (https://github.com/davfuenmayor/ruby-doxygen-parser)
   which on his part depends on Nokogiri (http://nokogiri.org) and Doxygen (www.doxygen.org).
   Refer to Doxyparser for more information.\nFor using EasySwig you may also want
-  to install SWIG (http://www.swig.org/). Currently only SWIG version 2.0.11 is supported.
-  There is  ongoing work on 3.0.0 version support.\n\nEasySwig supports currently
-  only C#. There is  ongoing work on other languages support.\n\n"
+  to install SWIG (http://www.swig.org/). SWIG versions 2.x and 3.x are supported.\n\nEasySwig
+  supports currently only C#. There is  ongoing work on other languages support.\n\n"
 email:
 - davfuenmayor@gmail.com
 executables: []