/home/gian/Progetti/falcon/core/include/falcon/module.h

Go to the documentation of this file.

/*
   FALCON - The Falcon Programming Language.
   FILE: module.h

   Falcon module extensions.
   -------------------------------------------------------------------
   Author: Giancarlo Niccolai
   Begin: mar ago 3 2004

   -------------------------------------------------------------------
   (C) Copyright 2004: the FALCON developers (see list in AUTHORS file)

   See LICENSE file for licensing details.
*/

#ifndef FLC_MODULE_H
#define FLC_MODULE_H

#include <falcon/setup.h>
#include <falcon/string.h>
#include <falcon/symbol.h>
#include <falcon/symtab.h>
#include <falcon/types.h>
#include <falcon/deptab.h>
#include <falcon/linemap.h>
#include <falcon/dll.h>
#include <falcon/strtable.h>
#include <falcon/service.h>
#include <falcon/genericmap.h>
#include <falcon/basealloc.h>

namespace Falcon {

class String;
class Stream;
class AttribMap;

class FALCON_DYN_CLASS Module: public BaseAlloc
{
protected:

   mutable volatile int32 m_refcount;

   /******************************
   * Anagraphic section
   *******************************/
   char m_version;
   char m_subversion;
   String m_name;
   String m_path;
   String m_language;
   uint32 m_modVersion;
   uint32 m_engineVersion;

   /******************************
   * Tables section
   *******************************/
   StringTable* m_strTab;
   bool m_bOwnStringTable;
   SymbolVector m_symbols;
   SymbolTable m_symtab;
   DependTable m_depend;
   LineMap *m_lineInfo;

   DllLoader *m_loader;

   DllLoader *detachLoader();

   Map m_serviceMap;

   AttribMap* m_attributes;

   virtual ~Module();

public:

   static const uint32 c_noEntry;
   Module();
   Module &name( const String &n ) { m_name.bufferize( n ); return *this; }
   Module &path( const String &p ) { m_path.bufferize( p ); return *this; }
   Module &language( const String &lang ) { m_language = lang; return *this; }


   Module &version( uint32 version ) { m_modVersion = version; return *this; }
   Module &version( int major, int minor, int revision ) {
      m_modVersion = major << 16 | minor << 8 | revision;
      return *this;
   }

   Module &engineVersion( uint32 version ) { m_engineVersion = version; return *this; }
   Module &engineVersion( int major, int minor, int revision )  {
      m_engineVersion = major << 16 | minor << 8 | revision;
      return *this;
   }

   virtual char pcodeVersion() const;
   virtual char pcodeSubVersion() const;

   void incref() const;
   void decref() const;

   virtual bool isFlexy() const { return false; }


   Symbol *findGlobalSymbol( const String &name ) const
   {
      return m_symtab.findByName( name );
   }

   const String &name() const { return m_name; }
   const String &path() const { return m_path; }
   const String &language() const { return m_language;}

   String *addCString( const char *pos, uint32 size );

   String *addString( const String &st );

   String *addString( const String &st, bool exported );

   const String *getString( uint32 id ) const { return m_strTab->get(id); }

   Symbol *getSymbol( uint32 id ) const
   {
      if ( id > m_symbols.size() )
         return 0;
      return *(Symbol **) m_symbols.at(id);
   }

   const SymbolTable &symbolTable() const {
      return m_symtab;
   }

   SymbolTable &symbolTable() {
      return m_symtab;
   }


   const SymbolVector &symbols() const {
      return m_symbols;
   }

   SymbolVector &symbols() {
      return m_symbols;
   }

   const DependTable &dependencies() const {
      return m_depend;
   }

   void addDepend( const String &name, bool bPrivate = false, bool bIsFilename = false  );

   void addDepend( const String &alias, const String &module, bool bPrivate=false, bool bIsFilename = false );


   void addSymbol( Symbol *sym );

   Symbol *addSymbol( const String &name );

   Symbol *addExternalRef( const String &name ) {
      return addGlobalSymbol( addSymbol( name ) );
   }

   Symbol *addExtFunc( const String &name, ext_func_t func, bool exp = true )
   {
      return addExtFunc( name, func, 0, exp );
   }

   Symbol *addExtFunc( const String &name, ext_func_t func, void *extra, bool exp = true );


   Symbol *addSymbol();


   Symbol *addGlobalSymbol( Symbol *sym );


   Symbol *addGlobal( const String &name, bool exp=true );

   VarDef& addClassProperty( Symbol *cls, const String &prop );

   VarDef& addClassMethod( Symbol *cls, const String &prop, Symbol *method );

   VarDef& addClassMethod( Symbol *cls, const String &prop, ext_func_t func );


    Symbol *addFunction( const String &name, byte *code, uint32 size, bool exp=true );

   Symbol *addClass( const String &name, Symbol *ctor_sym, bool exp=true );

   Symbol *addClass( const String &name, ext_func_t ctor, bool exp=true );

   Symbol *addClass( const String &name, bool exp=true ) {
      return addClass( name, static_cast<Symbol *>( 0 ), exp );
   }

   Symbol *addSingleton( const String &name, Symbol *ctor_sym=0, bool exp = true );

   Symbol *addSingleton( const String &name, ext_func_t ctor, bool exp = true );

   uint32 getLineAt( uint32 pc ) const;

   void addLineInfo( uint32 pc, uint32 line );

   void setLineInfo( LineMap *infos );

   DllLoader &dllLoader();


   virtual bool save( Stream *os, bool skipCode=false ) const;

   virtual bool load( Stream *is, bool skipHeader=true );

   const StringTable &stringTable() const { return *m_strTab; }
   StringTable &stringTable() { return *m_strTab; }

   void adoptStringTable( StringTable *st, bool bOwn = false );

   Service *getService( const String &name ) const;

   bool publishService( Service *sp );

   const Map &getServiceMap() const { return m_serviceMap; }

   Symbol *addConstant( const String &name, int64 value, bool exp = true );

   Symbol *addConstant( const String &name, numeric value, bool exp = true );

   Symbol *addConstant( const String &name, const String &value, bool exp = true );

   void getModuleVersion( int &major, int &minor, int &revision ) const;

   void getEngineVersion( int &major, int &minor, int &revision ) const;

   bool saveTableTemplate( Stream *stream, const String &encoding ) const;

   static String absoluteName( const String &module_name, const String &parent_name );

   void addAttribute( const String &name, VarDef* vd );

   AttribMap* attributes() const { return m_attributes; }

   void rollBackSymbols( uint32 size );
};

}

//====================================================
// Module declaration and service macros
//

// module init and declaration
#define DEFALUT_FALCON_MODULE_INIT falcon_module_init

#define FALCON_MODULE_DECL \
   FALCON_MODULE_TYPE DEFALUT_FALCON_MODULE_INIT()

// Module string table service functions
#ifndef FAL_STR
   #define FAL_STR( id )   vm->moduleString( id )
#endif

#endif

/* end of module.h */

---