basic/source/inc/image.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_SOURCE_INC_IMAGE_HXX
  21 #define INCLUDED_BASIC_SOURCE_INC_IMAGE_HXX
  22
  23 #include <basic/sbx.hxx>
  24 #include <rtl/ustring.hxx>
  25 #include "filefmt.hxx"
  26 #include <o3tl/typed_flags_set.hxx>
  27
  28 // This class reads in the image that's been produced by the compiler
  29 // and manages the access to the single elements.
  30
  31 enum class SbiImageFlags
  32 {
  33     NONE          = 0,
  34     EXPLICIT      = 0x0001,  // OPTION EXPLICIT is active
  35     COMPARETEXT   = 0x0002,  // OPTION COMPARE TEXT is active
  36     INITCODE      = 0x0004,  // Init-Code does exist
  37     CLASSMODULE   = 0x0008,  // OPTION ClassModule is active
  38 };
  39 namespace o3tl
  40 {
  41     template<> struct typed_flags<SbiImageFlags> : is_typed_flags<SbiImageFlags, 0xf> {};
  42 }
  43
  44 class SbiImage {
  45     friend class SbiCodeGen;            // compiler classes, that the private-
  46
  47     SbxArrayRef    rTypes;          // User defined types
  48     SbxArrayRef    rEnums;          // Enum types
  49     std::vector<sal_uInt32>  mvStringOffsets; // StringId-Offsets
  50     std::unique_ptr<sal_Unicode[]> pStrings;        // StringPool
  51     std::unique_ptr<char[]>        pCode;           // Code-Image
  52     std::unique_ptr<char[]>        pLegacyPCode;        // Code-Image
  53     bool           bError;
  54     SbiImageFlags  nFlags;
  55     sal_uInt32     nStringSize;
  56     sal_uInt32     nCodeSize;
  57     sal_uInt16     nLegacyCodeSize;
  58     sal_uInt16     nDimBase;        // OPTION BASE value
  59     rtl_TextEncoding eCharSet;
  60                                     // temporary management-variable:
  61     short          nStringIdx;
  62     sal_uInt32     nStringOff;      // current Pos in the stringbuffer
  63                                     // routines for the compiler:
  64     void MakeStrings( short );      // establish StringPool
  65     void AddString( const OUString& );
  66     void AddCode( std::unique_ptr<char[]>, sal_uInt32 );
  67     void AddType(SbxObject const *);
  68     void AddEnum(SbxObject *);
  69
  70 public:
  71     OUString aName;          // macro name
  72     OUString aOUSource;      // source code
  73     OUString aComment;
  74     bool   bInit;
  75     bool   bFirstInit;
  76
  77     SbiImage();
  78    ~SbiImage();
  79     void Clear();
  80     bool Load( SvStream&, sal_uInt32& nVer );
  81                             // nVer is set to version
  82                             // of image
  83     bool Save( SvStream&, sal_uInt32 = B_CURVERSION );
  84     bool IsError() const            { return bError;    }
  85
  86     const char* GetCode() const     { return pCode.get();     }
  87     sal_uInt32  GetCodeSize() const { return nCodeSize; }
  88     sal_uInt16  GetBase() const     { return nDimBase;  }
  89     OUString    GetString( short nId ) const;
  90     const SbxObject* FindType (const OUString& aTypeName) const;
  91
  92     const SbxArrayRef& GetEnums() const { return rEnums; }
  93
  94     void        SetFlag( SbiImageFlags n ) { nFlags |= n;      }
  95     bool        IsFlag( SbiImageFlags n ) const { return bool(nFlags & n); }
  96     sal_uInt16  CalcLegacyOffset( sal_Int32 nOffset );
  97     sal_uInt32  CalcNewOffset( sal_Int16 nOffset );
  98     void        ReleaseLegacyBuffer();
  99     bool        ExceedsLegacyLimits();
 100 };
 101
 102 #endif
 103
 104 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */