doc/salome/gui/SMESH/collect_mesh_methods.py

   1 #!/usr/bin/env python
   2 #  -*- coding: iso-8859-1 -*-
   3 # Copyright (C) 2012-2016  CEA/DEN, EDF R&D, OPEN CASCADE
   4 #
   5 # This library is free software; you can redistribute it and/or
   6 # modify it under the terms of the GNU Lesser General Public
   7 # License as published by the Free Software Foundation; either
   8 # version 2.1 of the License, or (at your option) any later version.
   9 #
  10 # This library is distributed in the hope that it will be useful,
  11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 # Lesser General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU Lesser General Public
  16 # License along with this library; if not, write to the Free Software
  17 # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18 #
  19 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  20 #
  21
  22 #################################################################################
  23 #
  24 # File:   collect_mesh_methods.py
  25 # Author: Vadim SANDLER, Open CASCADE S.A.S (vadim.sandler@opencascade.com)
  26 #
  27 #################################################################################
  28 #
  29 # Extraction of the meshing algorithm classes
  30 # dynamically added by the plug-in to the Mesh
  31 # class.
  32 #
  33 # This script is intended for internal usage - only
  34 # for generatation of the extra developer documentation for
  35 # the meshing plug-in(s).
  36 #
  37 # Usage:
  38 #       collect_mesh_methods.py <plugin_name>
  39 # where
  40 #   <plugin_name> is a name of the plug-in module
  41 #
  42 # Notes:
  43 # - the script is supposed to be run in correct environment
  44 # i.e. PYTHONPATH, SMESH_MeshersList and other important
  45 # variables are set properly; otherwise the script will fail.
  46 #
  47 ################################################################################
  48
  49 import sys
  50
  51 def main(plugin_name, dummymeshhelp = True, output_file = "smeshBuilder.py"):
  52     plugin_module_name  = plugin_name + "Builder"
  53     plugin_module       = "salome.%s.%s" % (plugin_name, plugin_module_name)
  54     try:
  55         exec( "from salome.smesh.smeshBuilder import *")
  56         exec( "import %s" % plugin_module )
  57         exec( "mod = %s" % plugin_module )
  58         methods = {}
  59         for attr in dir( mod ):
  60             if attr.startswith( '_' ): continue
  61             algo = getattr( mod, attr )
  62             if type( algo ).__name__ == 'classobj' and hasattr( algo, "meshMethod" ):
  63                 method = getattr( algo, "meshMethod" )
  64                 if method not in methods: methods[ method ] = []
  65                 methods[ method ].append( algo )
  66                 pass
  67             pass
  68         if methods:
  69             output = []
  70             if dummymeshhelp:
  71                 output.append( "## @package smeshBuilder" )
  72                 output.append( "#  Documentation of the methods dynamically added by the " + plugin_name + " meshing plug-in to the Mesh class." )
  73                 output.append( "" )
  74                 pass
  75             output.append( "## This class allows defining and managing a mesh." )
  76             output.append( "#" )
  77             if dummymeshhelp:
  78                 # Add dummy Mesh help
  79                 # This is supposed to be done when generating documentation for meshing plug-ins
  80                 output.append( "#  @note The documentation below does not provide complete description of class @b %Mesh" )
  81                 output.append( "#  from @b smeshBuilder package. This documentation provides only information about" )
  82                 output.append( "#  the methods dynamically added to the %Mesh class by the " + plugin_name + " plugin" )
  83                 output.append( "#  For more details on the %Mesh class, please refer to the SALOME %Mesh module" )
  84                 output.append( "#  documentation." )
  85                 pass
  86             else:
  87                 # Extend documentation for Mesh class with information about dynamically added methods.
  88                 # This is supposed to be done only when building documentation for SMESH module
  89                 output.append( "#  @note Some methods are dynamically added to the @b %Mesh class in runtime by meshing " )
  90                 output.append( "#  plug-in modules. If you fail to find help on some methods in the documentation of SMESH module, " )
  91                 output.append( "#  try to look into the documentation for the meshing plug-ins." )
  92                 pass
  93             output.append( "class Mesh:" )
  94             for method in methods:
  95                 docHelper = ""
  96                 for algo in methods[ method ]:
  97                     if hasattr( algo, "docHelper" ): docHelper = getattr( algo, "docHelper" )
  98                     if docHelper: break
  99                     pass
 100                 if not docHelper: docHelper = "Creates new algorithm."
 101                 output.append( " ## %s" % docHelper )
 102                 output.append( " #" )
 103                 output.append( " #  This method is dynamically added to %Mesh class by the meshing plug-in(s). " )
 104                 output.append( " #" )
 105                 output.append( " #  If the optional @a geom_shape parameter is not set, this algorithm is global (applied to whole mesh)." )
 106                 output.append( " #  Otherwise, this algorithm defines a submesh based on @a geom_shape subshape." )
 107                 output.append( " #  @param algo_type type of algorithm to be created; allowed values are specified by classes implemented by plug-in (see below)" )
 108                 output.append( " #  @param geom_shape if defined, the subshape to be meshed (GEOM_Object)" )
 109                 output.append( " #  @return An instance of Mesh_Algorithm sub-class according to the specified @a algo_type, see " )
 110                 output.append( " #  %s" % ", ".join( [ "%s.%s" % ( plugin_module_name, algo.__name__ ) for algo in methods[ method ] ] ) )
 111                 output.append( " def %s(algo_type, geom_shape=0):" % method )
 112                 output.append( "   pass" )
 113                 pass
 114             f = open(output_file, "w")
 115             for line in output: f.write( line + "\n" )
 116             f.close()
 117             pass
 118         pass
 119     except Exception, e:
 120         print e
 121         pass
 122     pass
 123
 124 if __name__ == "__main__":
 125     import optparse
 126     parser = optparse.OptionParser(usage="%prog [options] plugin")
 127     h  = "Output file (smesh.py by default)"
 128     parser.add_option("-o", "--output", dest="output",
 129                       action="store", default=None, metavar="file",
 130                       help=h)
 131     h  = "If this option is True, dummy help for Mesh class is added. "
 132     h += "This option should be False (default) when building documentation for SMESH module "
 133     h += "and True when building documentation for meshing plug-ins."
 134     parser.add_option("-d", "--dummy-mesh-help", dest="dummymeshhelp",
 135                       action="store_true", default=False,
 136                       help=h)
 137     (options, args) = parser.parse_args()
 138
 139     if len( args ) < 1: sys.exit("Plugin name is not specified")
 140     main( args[0], options.dummymeshhelp, options.output )
 141     pass