include/basic/sbmod.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef INCLUDED_BASIC_SBMOD_HXX
  21 #define INCLUDED_BASIC_SBMOD_HXX
  22
  23 #include <com/sun/star/script/XInvocation.hpp>
  24 #include <basic/sbdef.hxx>
  25 #include <basic/sbxobj.hxx>
  26 #include <basic/sbxdef.hxx>
  27 #include <basic/sbx.hxx>
  28 #include <rtl/ustring.hxx>
  29 #include <vector>
  30 #include <deque>
  31 #include <basic/basicdllapi.h>
  32 #include <basic/codecompletecache.hxx>
  33
  34 class SbMethod;
  35 class SbProperty;
  36 class SbiRuntime;
  37 typedef std::deque< sal_uInt16 > SbiBreakpoints;
  38 class SbiImage;
  39 class SbProcedureProperty;
  40 class SbIfaceMapperMethod;
  41 class SbClassModuleObject;
  42
  43
  44 class ModuleInitDependencyMap;
  45 struct ClassModuleRunInitItem;
  46 struct SbClassData;
  47
  48 class BASIC_DLLPUBLIC SbModule : public SbxObject
  49 {
  50     friend class    SbiCodeGen;
  51     friend class    SbMethod;
  52     friend class    SbiRuntime;
  53     friend class    StarBASIC;
  54     friend class    SbClassModuleObject;
  55
  56     std::vector< OUString > mModuleVariableNames;
  57
  58     BASIC_DLLPRIVATE void implClearIfVarDependsOnDeletedBasic( SbxVariable* pVar, StarBASIC* pDeletedBasic );
  59
  60     SbModule(const SbModule&) SAL_DELETED_FUNCTION;
  61     SbModule& operator=(const SbModule&) SAL_DELETED_FUNCTION;
  62 protected:
  63     com::sun::star::uno::Reference< com::sun::star::script::XInvocation > mxWrapper;
  64     OUString            aOUSource;
  65     OUString            aComment;
  66     SbiImage*           pImage;        // the Image
  67     SbiBreakpoints*     pBreaks;       // Breakpoints
  68     SbClassData*        pClassData;
  69     bool mbVBACompat;
  70     sal_Int32 mnType;
  71     SbxObjectRef pDocObject; // an impl object ( used by Document Modules )
  72     bool    bIsProxyModule;
  73
  74     static void     implProcessModuleRunInit( ModuleInitDependencyMap& rMap, ClassModuleRunInitItem& rItem );
  75     void            StartDefinitions();
  76     SbMethod*       GetMethod( const OUString&, SbxDataType );
  77     SbProperty*     GetProperty( const OUString&, SbxDataType );
  78     SbProcedureProperty* GetProcedureProperty( const OUString&, SbxDataType );
  79     SbIfaceMapperMethod* GetIfaceMapperMethod( const OUString&, SbMethod* );
  80     void            EndDefinitions( bool=false );
  81     void            Run( SbMethod* );
  82     void            RunInit();
  83     void            ClearPrivateVars();
  84     void            ClearVarsDependingOnDeletedBasic( StarBASIC* pDeletedBasic );
  85     void            GlobalRunInit( bool bBasicStart );  // for all modules
  86     void            GlobalRunDeInit();
  87     const sal_uInt8* FindNextStmnt( const sal_uInt8*, sal_uInt16&, sal_uInt16& ) const;
  88     const sal_uInt8* FindNextStmnt( const sal_uInt8*, sal_uInt16&, sal_uInt16&,
  89                                     bool bFollowJumps, const SbiImage* pImg=NULL ) const;
  90     virtual bool LoadData( SvStream&, sal_uInt16 ) SAL_OVERRIDE;
  91     virtual bool StoreData( SvStream& ) const SAL_OVERRIDE;
  92     virtual bool LoadCompleted() SAL_OVERRIDE;
  93     virtual void SFX_NOTIFY( SfxBroadcaster& rBC, const TypeId& rBCType,
  94                              const SfxHint& rHint, const TypeId& rHintType ) SAL_OVERRIDE;
  95     void handleProcedureProperties( SfxBroadcaster& rBC, const SfxHint& rHint );
  96     virtual ~SbModule();
  97 public:
  98     SBX_DECL_PERSIST_NODATA(SBXCR_SBX,SBXID_BASICMOD,2);
  99     TYPEINFO_OVERRIDE();
 100                     SbModule( const OUString&, bool bCompat = false );
 101     virtual void    SetParent( SbxObject* ) SAL_OVERRIDE;
 102     virtual void    Clear() SAL_OVERRIDE;
 103
 104     virtual SbxVariable* Find( const OUString&, SbxClassType ) SAL_OVERRIDE;
 105
 106     const OUString&  GetSource() const;
 107     const OUString&  GetSource32() const { return aOUSource;}
 108     const OUString&  GetComment() const { return aComment; }
 109     void             SetSource32( const OUString& r );
 110
 111     bool Compile();
 112     bool IsCompiled() const;
 113     const SbxObject* FindType( const OUString& aTypeName ) const;
 114
 115     bool IsBreakable( sal_uInt16 nLine ) const;
 116     bool IsBP( sal_uInt16 nLine ) const;
 117     bool SetBP( sal_uInt16 nLine );
 118     bool ClearBP( sal_uInt16 nLine );
 119     void ClearAllBP();
 120
 121     // Store only image, no source (needed for new password protection)
 122     bool     StoreBinaryData( SvStream&, sal_uInt16 nVer );
 123     bool     LoadBinaryData( SvStream&, sal_uInt16 nVer );
 124     bool     LoadBinaryData( SvStream& );
 125     bool     ExceedsLegacyModuleSize();
 126     void     fixUpMethodStart( bool bCvtToLegacy, SbiImage* pImg = NULL ) const;
 127     bool     HasExeCode();
 128     bool     IsVBACompat() const { return mbVBACompat;}
 129     void     SetVBACompat( bool bCompat );
 130     sal_Int32 GetModuleType() { return mnType; }
 131     void     SetModuleType( sal_Int32 nType ) { mnType = nType; }
 132     bool     isProxyModule() { return bIsProxyModule; }
 133     void     AddVarName( const OUString& aName );
 134     void     RemoveVars();
 135     ::com::sun::star::uno::Reference< ::com::sun::star::script::XInvocation > GetUnoModule();
 136     bool     createCOMWrapperForIface( ::com::sun::star::uno::Any& o_rRetAny, SbClassModuleObject* pProxyClassModuleObject );
 137     void     GetCodeCompleteDataFromParse(CodeCompleteDataCache& aCache);
 138     SbxArrayRef GetMethods() { return pMethods;}
 139     static OUString GetKeywordCase( const OUString& sKeyword );
 140 };
 141
 142 typedef tools::SvRef<SbModule> SbModuleRef;
 143
 144 // Object class for instances of class modules
 145 class BASIC_DLLPUBLIC SbClassModuleObject : public SbModule
 146 {
 147     SbModule*   mpClassModule;
 148     bool        mbInitializeEventDone;
 149
 150 public:
 151     TYPEINFO_OVERRIDE();
 152     SbClassModuleObject( SbModule* pClassModule );
 153     virtual ~SbClassModuleObject();
 154
 155     // Overridden to support NameAccess etc.
 156     virtual SbxVariable* Find( const OUString&, SbxClassType ) SAL_OVERRIDE;
 157
 158     virtual void SFX_NOTIFY( SfxBroadcaster&, const TypeId&, const SfxHint& rHint, const TypeId& ) SAL_OVERRIDE;
 159
 160     SbModule* getClassModule()
 161         { return mpClassModule; }
 162
 163     void triggerInitializeEvent();
 164     void triggerTerminateEvent();
 165 };
 166
 167 #endif
 168
 169 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */