basic/source/inc/runtime.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 #pragma once
  21
  22 #include <basic/sberrors.hxx>
  23 #include <basic/sbmeth.hxx>
  24 #include <basic/sbstar.hxx>
  25 #include <basic/sbx.hxx>
  26
  27 #include <rtl/ustring.hxx>
  28 #include <com/sun/star/uno/Sequence.hxx>
  29 #include <osl/file.hxx>
  30 #include <i18nlangtag/lang.h>
  31
  32 #include <cmath>
  33 #include <vector>
  34 #include <memory>
  35 #include <com/sun/star/lang/XComponent.hpp>
  36 #include <com/sun/star/container/XEnumeration.hpp>
  37 #include <unotools/localedatawrapper.hxx>
  38 #include <o3tl/deleter.hxx>
  39 #include <o3tl/typed_flags_set.hxx>
  40
  41 class SbiInstance;                  // active StarBASIC process
  42 class SbiRuntime;                   // active StarBASIC procedure instance
  43
  44 struct SbiArgv;                     // Argv stack element
  45 struct SbiGosub;                    // GOSUB stack element
  46 class  SbiImage;                    // Code-Image
  47 class  SbiIoSystem;
  48 class  SbiDdeControl;
  49 class  SbiDllMgr;
  50 class  SvNumberFormatter;           // time/date functions
  51 enum class SbiImageFlags;
  52
  53 enum class ForType {
  54     To,
  55     EachArray,
  56     EachCollection,
  57     EachXEnumeration,
  58     Error,
  59 };
  60
  61 struct SbiForStack {                // for/next stack:
  62     SbiForStack*    pNext;          // Chain
  63     SbxVariableRef  refVar;         // loop variable
  64     SbxVariableRef  refEnd;         // end expression / for each: Array/BasicCollection object
  65     SbxVariableRef  refInc;         // increment expression
  66
  67     // For each support
  68     ForType             eForType;
  69     sal_Int32           nCurCollectionIndex;
  70     std::unique_ptr<sal_Int32[]>
  71                         pArrayCurIndices;
  72     std::unique_ptr<sal_Int32[]>
  73                         pArrayLowerBounds;
  74     std::unique_ptr<sal_Int32[]>
  75                         pArrayUpperBounds;
  76     css::uno::Reference< css::container::XEnumeration > xEnumeration;
  77
  78     SbiForStack()
  79         : pNext(nullptr)
  80         , eForType(ForType::To)
  81         , nCurCollectionIndex(0)
  82     {}
  83 };
  84
  85 #define MAXRECURSION 500 //to prevent dead-recursions
  86
  87 enum class SbAttributes {
  88     NONE          = 0x0000,
  89     READONLY      = 0x0001,
  90     HIDDEN        = 0x0002,
  91     DIRECTORY     = 0x0010
  92 };
  93
  94 namespace o3tl
  95 {
  96     template<> struct typed_flags<SbAttributes> : is_typed_flags<SbAttributes, 0x13> {};
  97 }
  98
  99 class WildCard;
 100
 101 class SbiRTLData
 102 {
 103 public:
 104
 105     std::unique_ptr<osl::Directory> pDir;
 106     SbAttributes nDirFlags;
 107     short   nCurDirPos;
 108
 109     OUString sFullNameToBeChecked;
 110     std::unique_ptr<WildCard> pWildCard;
 111
 112     css::uno::Sequence< OUString > aDirSeq;
 113
 114     SbiRTLData();
 115     ~SbiRTLData();
 116 };
 117
 118 // The instance matches a running StarBASIC. Many basics running at the same
 119 // time are managed by chained instances. There is all the data that only lives
 120 // when the BASIC is living too, like the I/O-system.
 121
 122 typedef std::vector< css::uno::Reference< css::lang::XComponent > > ComponentVector_t;
 123
 124
 125 class SbiInstance
 126 {
 127     friend class SbiRuntime;
 128
 129     SbiRTLData      aRTLData;
 130
 131     // file system
 132     std::unique_ptr<SbiIoSystem, o3tl::default_delete<SbiIoSystem>> pIosys;
 133     // DDE
 134     std::unique_ptr<SbiDdeControl>    pDdeCtrl;
 135     // DLL-Calls (DECLARE)
 136     std::unique_ptr<SbiDllMgr>        pDllMgr;
 137     std::shared_ptr<SvNumberFormatter> pNumberFormatter;
 138     StarBASIC*      pBasic;
 139     LanguageType    meFormatterLangType;
 140     DateOrder       meFormatterDateOrder;
 141     sal_uInt32      nStdDateIdx, nStdTimeIdx, nStdDateTimeIdx;
 142
 143     ErrCode         nErr;
 144     OUString        aErrorMsg;      // last error message for $ARG
 145     sal_Int32       nErl;           // current error line
 146     bool        bReschedule;    // Flag: sal_True = Reschedule in main loop
 147     bool        bCompatibility; // Flag: sal_True = VBA runtime compatibility mode
 148
 149     ComponentVector_t ComponentVector;
 150 public:
 151     SbiRuntime*  pRun;              // Call-Stack
 152
 153     // #31460 new concept for StepInto/Over/Out,
 154     // explanation see runtime.cxx at SbiInstance::CalcBreakCallLevel()
 155     sal_uInt16  nCallLvl;
 156     sal_uInt16  nBreakCallLvl;
 157     void    CalcBreakCallLevel( BasicDebugFlags nFlags );
 158
 159     SbiInstance( StarBASIC* );
 160    ~SbiInstance();
 161
 162     void Error( ErrCode );                      // trappable Error
 163     void Error( ErrCode, const OUString& rMsg );  // trappable Error with message
 164     void ErrorVB( sal_Int32 nVBNumber, const OUString& rMsg );
 165     void setErrorVB( sal_Int32 nVBNumber );
 166     void FatalError( ErrCode );                 // non-trappable Error
 167     void FatalError( ErrCode, const OUString& );  // non-trappable Error
 168     void Abort();                               // with current error code
 169
 170     void    Stop();
 171     ErrCode const & GetErr() const       { return nErr; }
 172     const OUString& GetErrorMsg() const  { return aErrorMsg; }
 173     sal_Int32 GetErl() const             { return nErl; }
 174     void    EnableReschedule( bool bEnable ) { bReschedule = bEnable; }
 175     bool    IsReschedule() const { return bReschedule; }
 176     void    EnableCompatibility( bool bEnable ) { bCompatibility = bEnable; }
 177     bool    IsCompatibility() const { return bCompatibility; }
 178
 179     ComponentVector_t& getComponentVector()  { return ComponentVector; }
 180
 181     SbMethod* GetCaller( sal_uInt16 );
 182     SbModule* GetActiveModule();
 183
 184     SbiIoSystem* GetIoSystem() { return pIosys.get(); }
 185     SbiDdeControl* GetDdeControl() { return pDdeCtrl.get(); }
 186     StarBASIC* GetBasic() { return pBasic; }
 187     SbiDllMgr* GetDllMgr();
 188     SbiRTLData& GetRTLData() const { return const_cast<SbiRTLData&>(aRTLData); }
 189
 190     std::shared_ptr<SvNumberFormatter> const & GetNumberFormatter();
 191     sal_uInt32 GetStdDateIdx() const { return nStdDateIdx; }
 192     sal_uInt32 GetStdTimeIdx() const { return nStdTimeIdx; }
 193     sal_uInt32 GetStdDateTimeIdx() const { return nStdDateTimeIdx; }
 194
 195     // offer NumberFormatter also static
 196     static std::shared_ptr<SvNumberFormatter> PrepareNumberFormatter( sal_uInt32 &rnStdDateIdx,
 197         sal_uInt32 &rnStdTimeIdx, sal_uInt32 &rnStdDateTimeIdx,
 198         LanguageType const * peFormatterLangType=nullptr, DateOrder const * peFormatterDateOrder=nullptr );
 199 };
 200
 201 // There's one instance of this class for every executed sub-program.
 202 // This instance is the heart of the BASIC-machine and contains only local data.
 203
 204 class SbiRuntime
 205 {
 206     friend void SbRtl_CallByName( StarBASIC* pBasic, SbxArray& rPar, bool bWrite );
 207
 208     typedef void( SbiRuntime::*pStep0 )();
 209     typedef void( SbiRuntime::*pStep1 )( sal_uInt32 nOp1 );
 210     typedef void( SbiRuntime::*pStep2 )( sal_uInt32 nOp1, sal_uInt32 nOp2 );
 211     static pStep0 aStep0[];         // opcode-table group 0
 212     static pStep1 aStep1[];
 213     static pStep2 aStep2[];
 214
 215     StarBASIC&         rBasic;           // StarBASIC instance
 216     SbiInstance*       pInst;            // current thread
 217     SbModule*          pMod;             // current module
 218     SbMethod*          pMeth;            // method instance
 219     SbiIoSystem*       pIosys;           // I/O-System
 220     const SbiImage*    pImg;             // Code-Image
 221     SbxArrayRef        refExprStk;       // expression stack
 222     SbxArrayRef        refCaseStk;       // CASE expression stack
 223     SbxArrayRef        refRedimpArray;   // Array saved to use for REDIM PRESERVE
 224     SbxVariableRef     refRedim;         // Array saved to use for REDIM
 225     SbxVariableRef     xDummyVar;        // substitute for variables that weren't found
 226     SbxVariable*       mpExtCaller;      // Caller ( external - e.g. button name, shape, range object etc. - only in vba mode )
 227     SbiForStack*       pForStk;          // FOR/NEXT-Stack
 228     sal_uInt16         nExprLvl;         // depth of the expr-stack
 229     sal_uInt16         nForLvl;          // #118235: Maintain for level
 230     const sal_uInt8*   pCode;            // current Code-Pointer
 231     const sal_uInt8*   pStmnt;           // beginning of the last statement
 232     const sal_uInt8*   pError;           // address of the current error handler
 233     const sal_uInt8*   pRestart;         // restart-address
 234     const sal_uInt8*   pErrCode;         // restart-address RESUME NEXT
 235     const sal_uInt8*   pErrStmnt;        // restart-address RESUME 0
 236     OUString           aLibName;         // Lib-name for declare-call
 237     SbxArrayRef        refParams;        // current procedure parameters
 238     SbxArrayRef        refLocals;        // local variable
 239     SbxArrayRef        refArgv;
 240     // #74254, one refSaveObj is not enough! new: pRefSaveList (see above)
 241     short              nArgc;
 242     bool               bRun;
 243     bool               bError;           // true: handle errors
 244     bool               bInError;         // true: in an error handler
 245     bool               bBlocked;         // true: blocked by next call level, #i48868
 246     bool               bVBAEnabled;
 247     BasicDebugFlags    nFlags;           // Debugging-Flags
 248     ErrCode            nError;
 249     sal_uInt16         nOps;             // opcode counter
 250     sal_uInt32         m_nLastTime;
 251
 252     std::vector<SbxVariableRef>  aRefSaved; // #74254 save temporary references
 253     std::vector<SbiGosub>   pGosubStk;      // GOSUB stack
 254     std::vector<SbiArgv>    pArgvStk;       // ARGV-Stack
 255
 256
 257     SbxVariable* FindElement
 258     ( SbxObject* pObj, sal_uInt32 nOp1, sal_uInt32 nOp2, ErrCode, bool bLocal, bool bStatic = false );
 259     void SetupArgs( SbxVariable*, sal_uInt32 );
 260     SbxVariable* CheckArray( SbxVariable* );
 261
 262     void PushVar( SbxVariable* );
 263     SbxVariableRef PopVar();
 264     SbxVariable* GetTOS();
 265     void TOSMakeTemp();
 266     void ClearExprStack();
 267
 268     void PushGosub( const sal_uInt8* );
 269     void PopGosub();
 270
 271     void PushArgv();
 272     void PopArgv();
 273     void ClearArgvStack();
 274
 275     void PushFor();
 276     void PushForEach();
 277     void PopFor();
 278     void ClearForStack();
 279
 280     void StepArith( SbxOperator );
 281     void StepUnary( SbxOperator );
 282     void StepCompare( SbxOperator );
 283
 284     void SetParameters( SbxArray* );
 285
 286     // HAS TO BE IMPLEMENTED SOME TIME
 287     void DllCall( const OUString&, const OUString&, SbxArray*, SbxDataType, bool );
 288
 289     // #56204 swap out DIM-functionality into help method (step0.cxx)
 290     void DimImpl(const SbxVariableRef& refVar);
 291
 292     static bool implIsClass( SbxObject const * pObj, const OUString& aClass );
 293
 294     void StepSETCLASS_impl( sal_uInt32 nOp1, bool bHandleDflt );
 295
 296     // the following routines are called by the single
 297     // stepper and implement the single opcodes
 298     void StepNOP(),     StepEXP(),      StepMUL(),      StepDIV();
 299     void StepMOD(),     StepPLUS(),     StepMINUS(),    StepNEG();
 300     void StepEQ(),      StepNE(),       StepLT(),       StepGT();
 301     void StepLE(),      StepGE(),       StepIDIV(),     StepAND();
 302     void StepOR(),      StepXOR(),      StepEQV(),      StepIMP();
 303     void StepNOT(),     StepCAT(),      StepLIKE(),     StepIS();
 304     void StepARGC();
 305     void StepARGV(),    StepINPUT(),    StepLINPUT(),   StepSTOP();
 306     void StepGET(),     StepSET(),  StepVBASET(),   StepPUT(),      StepPUTC();
 307     void StepSET_Impl( SbxVariableRef& refVal, SbxVariableRef& refVar, bool bDefaultHandling = false );
 308     void StepDIM(),     StepREDIM(),    StepREDIMP(),   StepERASE();
 309     void StepINITFOR(), StepNEXT(),     StepERROR(),    StepINITFOREACH();
 310     void StepCASE(),    StepENDCASE(),  StepSTDERROR();
 311     void StepNOERROR(), StepCHANNEL(),  StepCHANNEL0(), StepPRINT();
 312     void StepPRINTF(),  StepWRITE(),    StepRENAME(),   StepPROMPT();
 313     void StepRESTART(), StepEMPTY(),    StepLEAVE();
 314     void StepLSET(),    StepRSET(),     StepREDIMP_ERASE(),     StepERASE_CLEAR();
 315     void StepARRAYACCESS(), StepBYVAL();
 316     // all opcodes with one operand
 317     void StepLOADNC( sal_uInt32 ),  StepLOADSC( sal_uInt32 ),   StepLOADI( sal_uInt32 );
 318     void StepARGN( sal_uInt32 ),    StepBASED( sal_uInt32 ),    StepPAD( sal_uInt32 );
 319     void StepJUMP( sal_uInt32 ),    StepJUMPT( sal_uInt32 );
 320     void StepJUMPF( sal_uInt32 ),   StepONJUMP( sal_uInt32 );
 321     void StepGOSUB( sal_uInt32 ),   StepRETURN( sal_uInt32 );
 322     void StepTESTFOR( sal_uInt32 ), StepCASETO( sal_uInt32 ),   StepERRHDL( sal_uInt32 );
 323     void StepRESUME( sal_uInt32 ),  StepSETCLASS( sal_uInt32 ), StepVBASETCLASS( sal_uInt32 ),  StepTESTCLASS( sal_uInt32 ), StepLIB( sal_uInt32 );
 324     bool checkClass_Impl( const SbxVariableRef& refVal, const OUString& aClass, bool bRaiseErrors, bool bDefault );
 325     void StepCLOSE( sal_uInt32 ),   StepPRCHAR( sal_uInt32 ),   StepARGTYP( sal_uInt32 );
 326     // all opcodes with two operands
 327     void StepRTL( sal_uInt32, sal_uInt32 ),     StepPUBLIC( sal_uInt32, sal_uInt32 ),   StepPUBLIC_P( sal_uInt32, sal_uInt32 );
 328     void StepPUBLIC_Impl( sal_uInt32, sal_uInt32, bool bUsedForClassModule );
 329     void StepFIND_Impl( SbxObject* pObj, sal_uInt32 nOp1, sal_uInt32 nOp2, ErrCode, bool bStatic = false );
 330     void StepFIND( sal_uInt32, sal_uInt32 ),    StepELEM( sal_uInt32, sal_uInt32 );
 331     void StepGLOBAL( sal_uInt32, sal_uInt32 ),  StepLOCAL( sal_uInt32, sal_uInt32 );
 332     void StepPARAM( sal_uInt32, sal_uInt32),    StepCREATE( sal_uInt32, sal_uInt32 );
 333     void StepCALL( sal_uInt32, sal_uInt32 ),    StepCALLC( sal_uInt32, sal_uInt32 );
 334     void StepCASEIS( sal_uInt32, sal_uInt32 ),  StepSTMNT( sal_uInt32, sal_uInt32 );
 335     SbxVariable* StepSTATIC_Impl(
 336         OUString const & aName, SbxDataType t, sal_uInt32 nOp2 );
 337     void StepOPEN( sal_uInt32, sal_uInt32 ),    StepSTATIC( sal_uInt32, sal_uInt32 );
 338     void StepTCREATE(sal_uInt32,sal_uInt32),    StepDCREATE(sal_uInt32,sal_uInt32);
 339     void StepGLOBAL_P( sal_uInt32, sal_uInt32 ),StepFIND_G( sal_uInt32, sal_uInt32 );
 340     void StepDCREATE_REDIMP(sal_uInt32,sal_uInt32), StepDCREATE_IMPL(sal_uInt32,sal_uInt32);
 341     void StepFIND_CM( sal_uInt32, sal_uInt32 );
 342     void StepFIND_STATIC( sal_uInt32, sal_uInt32 );
 343     static void implHandleSbxFlags( SbxVariable* pVar, SbxDataType t, sal_uInt32 nOp2 );
 344 public:
 345     void          SetVBAEnabled( bool bEnabled );
 346     bool          IsImageFlag( SbiImageFlags n ) const;
 347     sal_uInt16      GetBase() const;
 348     sal_Int32  nLine,nCol1,nCol2;
 349     SbiRuntime* pNext;               // Stack-Chain
 350
 351     // tdf#79426, tdf#125180 - adds the information about a missing parameter
 352     static void SetIsMissing( SbxVariable* );
 353     // tdf#79426, tdf#125180 - checks if a variable contains the information about a missing parameter
 354     static bool IsMissing( SbxVariable*, sal_uInt16 );
 355
 356     SbiRuntime( SbModule*, SbMethod*, sal_uInt32 );
 357    ~SbiRuntime();
 358     void Error( ErrCode, bool bVBATranslationAlreadyDone = false );     // set error if != 0
 359     void Error( ErrCode, const OUString& );       // set error if != 0
 360     void FatalError( ErrCode );                 // error handling = standard, set error
 361     void FatalError( ErrCode, const OUString& );  // error handling = standard, set error
 362     static sal_Int32 translateErrorToVba( ErrCode nError, OUString& rMsg );
 363     bool Step();                    // single step (one opcode)
 364     void Stop()            { bRun = false;   }
 365     void block()     { bBlocked = true; }
 366     void unblock()   { bBlocked = false; }
 367     SbModule* GetModule()  { return pMod;    }
 368     BasicDebugFlags GetDebugFlags() const { return nFlags;  }
 369     void SetDebugFlags( BasicDebugFlags nFl ) { nFlags = nFl;  }
 370     SbMethod* GetCaller() { return pMeth;}
 371     SbxVariable* GetExternalCaller(){ return mpExtCaller; }
 372
 373     SbiForStack* FindForStackItemForCollection( class BasicCollection const * pCollection );
 374
 375     SbxBase* FindElementExtern( const OUString& rName );
 376     static bool isVBAEnabled();
 377
 378 };
 379
 380 inline void checkArithmeticOverflow( double d )
 381 {
 382     if( !std::isfinite( d ) )
 383         StarBASIC::Error( ERRCODE_BASIC_MATH_OVERFLOW );
 384 }
 385
 386 inline void checkArithmeticOverflow( SbxVariable const * pVar )
 387 {
 388     if( pVar->GetType() == SbxDOUBLE )
 389     {
 390         double d = pVar->GetDouble();
 391         checkArithmeticOverflow( d );
 392     }
 393 }
 394
 395
 396 StarBASIC* GetCurrentBasic( StarBASIC* pRTBasic );
 397
 398 // Returns true if UNO is available, otherwise the old
 399 // file system implementation has to be used
 400 // (Implemented in iosys.cxx)
 401 bool hasUno();
 402
 403 // Converts possibly relative paths to absolute paths
 404 // according to the setting done by ChDir/ChDrive
 405 // (Implemented in methods.cxx)
 406 OUString getFullPath( const OUString& aRelPath );
 407
 408 // Implementation of StepRENAME with UCB
 409 // (Implemented in methods.cxx, so step0.cxx
 410 // has not to be infected with UNO)
 411 void implStepRenameUCB( const OUString& aSource, const OUString& aDest );
 412
 413 void implStepRenameOSL( const OUString& aSource, const OUString& aDest );
 414 bool IsBaseIndexOne();
 415
 416 void removeDimAsNewRecoverItem( SbxVariable* pVar );
 417
 418 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */