riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

* ./hurricane/src : 

- Complete include re-organisation.
       include/hurricane/*.h            : kernel.
       include/hurricane/viewer/*.h     : hviewer.
       include/hurricane/inspector/*.h  : hinspector.
     Includes have been moved into subdirectories of .cpp files (as in
       crlcore).
   - Now you must include files like this :
       #include  <hurricane/Layer.h>
       #include  <hurricane/viewer/CellViewer.h>
       #include  <hurricane/inspector/HInspector.h>  
   - Suppressed viewer specific include path in FindHURRICANE.cmake.
   - Re-enabled documentation, with dot disabled as it seems to slow down
      doxygen.

 * ./crlcore/src/crlcore :
   - Adapted to new Hurricane include scheme. Corrected bugs in it's own
       include files (noticeably "Utilities.h").
This commit is contained in:
Jean-Paul Chaput 2008-05-21 22:43:52 +00:00
parent 9bdf529dc2
commit 9a49082767
3 changed files with 168 additions and 1322 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
hurricane/doc/hurricane/CMakeLists.txt
View File

@ -1,3 +1,8 @@
ADD_CUSTOM_TARGET(doc ALL cd ${HURRICANE_SOURCE_DIR}/doc/hurricane && ${DOXYGEN_EXECUTABLE} doxyfile)
INSTALL(DIRECTORY html/ DESTINATION /share/doc/en/html/hurricane) set ( htmlInstallDir /share/doc/en/html/hurricane )
add_custom_target ( doc ALL cd ${HURRICANE_SOURCE_DIR}/doc/hurricane && ${DOXYGEN_EXECUTABLE} doxyfile )
install ( DIRECTORY html DESTINATION ${htmlInstallDir} )
install ( FILES customHierarchy.html DESTINATION ${htmlInstallDir}/html )
install ( FILES customSummary.html DESTINATION ${htmlInstallDir}/html )

54
hurricane/doc/hurricane/SlotAdapter.dox
View File

@ -26,22 +26,22 @@
\code \code
class SlotAdapter { class SlotAdapter {
public: public:
virtual string _GetTypename () const; virtual string _getTypename () const;
virtual string _GetString () const; virtual string _getString () const;
virtual Record* _GetRecord () const; virtual Record* _getRecord () const;
inline virtual Slot* _GetSlot ( const string& name ) const; inline virtual Slot* _getSlot ( const string& name ) const;
}; };
\endcode \endcode
* *
* *
* Thoses methods correspond to : * Thoses methods correspond to :
* <ul> * <ul>
* <li>\b _GetTypeName() : the inspected object's type. * <li>\b _getTypeName() : the inspected object's type.
* <li>\b _GetString() : a synthetic string description of the * <li>\b _getString() : a synthetic string description of the
* object's state. * object's state.
* <li>\b _GetRecord() : the complete description of all object's * <li>\b _getRecord() : the complete description of all object's
* attributes (a list of Slot). * attributes (a list of Slot).
* <li>\b _GetSlot() : a Slot build from this SlotAdapter. As this * <li>\b _getSlot() : a Slot build from this SlotAdapter. As this
* function is supplied by default with the right implementation * function is supplied by default with the right implementation
* we will not detail it here. * we will not detail it here.
* </ul> * </ul>
@ -56,8 +56,8 @@ class SlotAdapter {
* must inherit from the NestedSlotAdapter class. * must inherit from the NestedSlotAdapter class.
* <li><b>User defined, without virtual methods</b> : thoses * <li><b>User defined, without virtual methods</b> : thoses
* objects must provides (as ordinary methods) * objects must provides (as ordinary methods)
* \b _GetTypeName() , \b _GetString() , \b _GetRecord() . * \b _getTypeName() , \b _getString() , \b _getRecord() .
* But \b not \b _GetSlot(). * But \b not \b _getSlot().
* <li><b>External objects</b> : that is, we cannot modify. * <li><b>External objects</b> : that is, we cannot modify.
* In this case we have to provide a specialised template * In this case we have to provide a specialised template
* overload for \b ProxyTypeName<>() , \b ProxyString<>() , * overload for \b ProxyTypeName<>() , \b ProxyString<>() ,
@ -78,13 +78,13 @@ namespace MyTool {
int _value; int _value;
public: public:
int GetValue () const { return _value; } int GetValue () const { return _value; }
virtual string _GetTypeName() const { return "MyClass"; }; virtual string _getTypeName() const { return "MyClass"; };
virtual string _GetString () const { return "<MyClass"+GetString(_value)+">"; }; virtual string _getString () const { return "<MyClass"+GetString(_value)+">"; };
virtual Record* _GetRecord () const; virtual Record* _getRecord () const;
}; };
Record* MyClass::GetRecord () const { Record* MyClass::GetRecord () const {
Record* record = new Record(_GetString()); Record* record = new Record(_getString());
record->Add ( GetSlot("_value",&_value) ); record->Add ( GetSlot("_value",&_value) );
return record; return record;
} }
@ -123,20 +123,20 @@ namespace MyTool {
int _value; int _value;
public: public:
int GetValue () const { return _value; } int GetValue () const { return _value; }
string _GetTypeName() const { return "MyLightClass"; }; string _getTypeName() const { return "MyLightClass"; };
string _GetString () const { return "<MyLightClass"+GetString(_value)+">"; }; string _getString () const { return "<MyLightClass"+GetString(_value)+">"; };
Record* _GetRecord () const; Record* _getRecord () const;
}; };
Record* MyLightClass::GetRecord () const { Record* MyLightClass::GetRecord () const {
Record* record = new Record(_GetString()); Record* record = new Record(_getString());
record->Add ( GetSlot("_value",&_value) ); record->Add ( GetSlot("_value",&_value) );
return record; return record;
} }
} // End of MyTool namespace. } // End of MyTool namespace.
\endcode \endcode
* *
* The methods \b _GetTypeName() , \b _GetString() and \b GetRecord() * The methods \b _getTypeName() , \b _getString() and \b GetRecord()
* are now non-virtual and there's no call to \b SetNestedSlotAdapter() . * are now non-virtual and there's no call to \b SetNestedSlotAdapter() .
* *
* *
@ -172,7 +172,7 @@ template<typename T> inline Hurricane::Slot* GetSlot ( const string& name, T t
* GetString() may be used to print some debugging informations * GetString() may be used to print some debugging informations
* on \stdout. * on \stdout.
* *
* GetSlot() used to built the various entries in a \b _GetRecord() * GetSlot() used to built the various entries in a \b _getRecord()
* method. * method.
* *
* <b>Argument type policy</b> * <b>Argument type policy</b>
@ -274,29 +274,29 @@ template<typename T> inline Hurricane::Slot* GetSlot ( const string& name, T t
*/ */
// \{ // \{
/*! \function string SlotAdapter::_GetTypeName () const; /*! \function string SlotAdapter::_getTypeName () const;
* \Return a string representing the object type. May be used by * \Return a string representing the object type. May be used by
* SlotAdapter::_GetString(). * SlotAdapter::_getString().
* *
* \note No default implementation is supplied. * \note No default implementation is supplied.
*/ */
/*! \function string SlotAdapter::_GetString () const; /*! \function string SlotAdapter::_getString () const;
* \Return a string representing the object name and characteristics * \Return a string representing the object name and characteristics
* in a synthetic way. Used, among other things, as title * in a synthetic way. Used, among other things, as title
* for the Inspector Record browser. * for the Inspector Record browser.
* *
* \note Default implementation is supplied, which returns the * \note Default implementation is supplied, which returns the
* string \c "SlotAdapter::_GetString()" . * string \c "SlotAdapter::_getString()" .
*/ */
/*! \function Record* SlotAdapter::_GetRecord () const; /*! \function Record* SlotAdapter::_getRecord () const;
* \Return a Record representing the object current state. * \Return a Record representing the object current state.
* *
* \note Default implementation is supplied, which returns \NULL. * \note Default implementation is supplied, which returns \NULL.
*/ */
/*! \function Slot* SlotAdapter::_GetSlot ( const string& name ) const; /*! \function Slot* SlotAdapter::_getSlot ( const string& name ) const;
* \param name the name to give to the Slot. Usually the class attribute * \param name the name to give to the Slot. Usually the class attribute
* name. * name.
* \return a Slot associated to this object to insert into another Record. * \return a Slot associated to this object to insert into another Record.
@ -306,7 +306,7 @@ template<typename T> inline Hurricane::Slot* GetSlot ( const string& name, T t
*/ */
/*! \function Slot* NestedSlotAdapter::_GetSlot ( const string& name ) const; /*! \function Slot* NestedSlotAdapter::_getSlot ( const string& name ) const;
* \param name the name to give to the Slot. Usually the class attribute * \param name the name to give to the Slot. Usually the class attribute
* name. * name.
* \return a Slot associated to this object to insert into another Record. * \return a Slot associated to this object to insert into another Record.

1427
hurricane/doc/hurricane/doxyfile
View File

File diff suppressed because it is too large Load Diff