Content:
-------


This Folder contains :
  - script      : the sources of the generator,
  - src         : the sources of the GUI
  - CppExamples : Some C++ component examples.
  - Doc         : the associated documentation.


The generator is a script file called hxx2salome, written in bash, that manage :
  - the code generation
  - the compilation of generated module
  - the update of Salome environment file

A GUI called ghx2salome, written with Qt, is wrapping the script.



Install:
-------

  The script can be used without any compilation.
  To use the GUI, you first have to install and compile it.

  ./build_configure
  ./configure --prefix=<absolute path of HXX2SALOME>
  make
  make install


       
Usage:
-----

    set HXX2SALOME_ROOT_DIR variable to <absolute path of HXX2SALOME/bin>

    with GUI : 
    --------
       
       ${HXX2SALOME_ROOT_DIR}/gxx2salome

    with script :
    -----------
      
       ${HXX2SALOME_ROOT_DIR}/hxx2salome [OPTIONS]  cppComponent_root_dir   cppComponent.hxx   libcppComponent.so  salome_install_dir
    
         - cppComponent_root_dir : install directory (absolute path) of the c++ component
         - cppComponent.hxx : header of the component
         - libcppComponent.so :shared library of the component
           (cppComponent.hxx and libcppComponent.so have to be found in cppComponent_root_dir!)
         - salome_install_dir : the directory where you want to install the generated component

       OPTIONS:
         -c : to compile after code generation
	 -l : to launch salome after compilation
	 -e environment_file  : to specify an salome environment file to source (for compiling)



       Examples:

         The following examples are based upon the C++ component given in CppExamples directory. 
	 To proceed it is first necessary to compile them.

         - export HXX2SALOME_ROOT_DIR=/home/crouzet/HXX2SALOME/bin;

         - $HXX2SALOME_ROOT_DIR/hxx2salome -c -l -e /home/crouzet/SALOME2/my_env_products.sh /home/crouzet/SALOME2/CPP/COMPO_CXX_INSTALL 
                                            Calculator.hxx libCALCULATORCXX.so /home/crouzet/SALOME2
    
         - $HXX2SALOME_ROOT_DIR/hxx2salome -c  -e /home/crouzet/SALOME2/my_env_products.sh /home/crouzet/SALOME2/CPP/COMPO_CXX_INSTALL 
	                                    Calc.hxx libCALCULCXX.so /home/crouzet/SALOME2