Add support for 'morse import <path>'

This allows to import pre-existing simulations in MORSE
for later run them with 'morse run' (or 'morse edit').

'path' must be a local path.

Partially fix morse-simulator#396

Author: Séverin Lemaignan

CMakeLists.txt

@@ -256,6 +256,7 @@ ELSE()
 		INSTALL(FILES ${SPHINX_MAN_OUTPUT}/morse.1.gz 
 					  ${SPHINX_MAN_OUTPUT}/morse-run.1.gz 
 					  ${SPHINX_MAN_OUTPUT}/morse-create.1.gz 
+					  ${SPHINX_MAN_OUTPUT}/morse-import.1.gz 
 					  ${SPHINX_MAN_OUTPUT}/morse-edit.1.gz 
 					  ${SPHINX_MAN_OUTPUT}/morse-check.1.gz 
 					  ${SPHINX_MAN_OUTPUT}/morse-add.1.gz 

bin/morse.in

@@ -464,6 +464,32 @@ def create_environment(args):
     logger.info("You can run it directly with \"morse run %s\" or you "
                 "can start editing it." % name)
 
+def import_environment(args):
+
+
+    path = os.path.abspath(args.path)
+    name = args.name
+    if not name:
+        name = os.path.basename(path)
+
+    force = args.force
+
+    site = get_site(name)
+    if not force and site:
+        logger.error("You already have a simulation environment "
+                     "called \"%s\" (pointing to <%s>)!" % (name, site))
+        logger.error("Use 'morse import -f <path>' to overwrite it.")
+        sys.exit()
+
+
+    add_site(name, path)
+
+    logger.info("The simulation environment <%s> has been successfully "
+                "imported." % name)
+    logger.info("You can run it directly with \"morse run %s\" or you "
+                "can start editing it." % name)
+
+
 def delete_environment(args):
 
     name = args.env
@@ -717,12 +743,21 @@ if __name__ == '__main__':
     subparsers = parser.add_subparsers(title="modes", description="type 'morse <mode> --help' for details", dest = "mode")
 
     # create
-    create_parser = subparsers.add_parser('create', help="create a new simulation environment in the current directory.")
+    create_parser = subparsers.add_parser('create', help="creates a new simulation environment in the current directory.")
     create_parser.add_argument('env', default="", help="the name of the environment to create.")
     create_parser.add_argument('-f', '--force', action='store_true',
                        help='forces the creation (possibly overwriting files).')
     create_parser.set_defaults(func=create_environment)
 
+    # import
+    import_parser = subparsers.add_parser('import', help="imports a pre-existing simulation environment.")
+    import_parser.add_argument('path', default="", help="the relative or absolute path to the environment. For instance './lab_sim_checkout'.")
+    import_parser.add_argument('name', default="", nargs='?', help="the name of the environment (extracted from path if not specified).")
+    import_parser.add_argument('-f', '--force', action='store_true',
+                       help='forces the import (possibly overwriting existing environment).')
+    import_parser.set_defaults(func=import_environment)
+
+
     # rm
     rm_parser = subparsers.add_parser('rm', help="deletes an existing simulation environment.")
     rm_parser.add_argument('env', default="", help="the environment to delete.")
@@ -732,7 +767,7 @@ if __name__ == '__main__':
 
 
     # add
-    add_parser = subparsers.add_parser('add', help="add a template for a component to an environment.")
+    add_parser = subparsers.add_parser('add', help="adds a template for a component to an environment.")
     add_parser.add_argument('type', choices=['robot', 'sensor', 'actuator'],
             help="the type of component you want to add.")
     add_parser.add_argument('name', default="", help="the name of the new component.")

doc/conf.py.in

@@ -211,6 +211,7 @@ man_pages = [("morse_man_page", "morse", "A robotics simulator based upon the Bl
              ("morse-run_man_page", "morse-run", "Runs a MORSE simulation", "", 1),
              ("morse-edit_man_page", "morse-edit", "Loads a MORSE simulation for further edition", "", 1),
              ("morse-create_man_page", "morse-create", "Creates a MORSE simulation environment", "", 1),
+             ("morse-import_man_page", "morse-import", "Imports a MORSE simulation environment", "", 1),
              ("morse-check_man_page", "morse-check", "Checks the MORSE configuration", "", 1),
              ("morse-add_man_page", "morse-add", "Adds a component to a MORSE simulation environment", "", 1),
              ("morse-rm_man_page", "morse-rm", "Removes a MORSE simulation environment", "", 1),

doc/man/morse-import_man_page.rst

@@ -0,0 +1,34 @@
+:orphan:
+
+morse import manual page
+========================
+
+Synopsis
+--------
+
+**morse import** [-h] [-f] path [name]
+
+Description
+-----------
+
+Imports a directory as a simulation environment, ie, adds an entry to MORSE's
+"sites" section of the configuration file (typically, $HOME/.morse/config) that
+refers to this directory.
+
+Options
+-------
+
+:path:          a relative or absolute path to the simulation
+                environment to import.
+:name:          the name given to the imported environment.
+                If not specified, default to the name of the
+                containing directory (path's basename).
+
+:-h, --help:   show this help message and exit
+:-f, --force:  forces the import (possibly overwriting existing entry).
+
+Refer to :manpage:`morse(1)` for global MORSE options.
+
+See Also
+--------
+:manpage:`morse(1)`

doc/man/morse_man_page.rst

@@ -50,7 +50,6 @@ See "man morse-<command>" for a documentation of each commands.
         to an existing simulation environment.
 :check:
         Checks the environment is correctly setup to run morse.
-
 :create:
         Creates a new simulation environment in the current directory.
         A template simulation scene is also created.
@@ -59,6 +58,8 @@ See "man morse-<command>" for a documentation of each commands.
         Open the given Blender scene or Python script in the Blender
         interface for edition. The simulation can be started by 
         pressing P.
+:import:
+        Imports a pre-existing simulation as a new simulation environment.
 :rm:
         Deletes an existing simulation environment.
 :run: