basic/source/inc/filefmt.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_FILEFMT_HXX
  21 #define INCLUDED_BASIC_SOURCE_INC_FILEFMT_HXX
  22
  23 class SvStream;
  24
  25 // Version  2: data type of the return value for publics
  26 // Version  3: new opcodes
  27 // Version  4: new opcodes
  28 // Version  5: bug (entry of STATIC-variables in the init code)
  29 // Version  6: new opcodes and bug (construct globals, without ending the BASIC)
  30 // Version  7: correction concerning the WITH-Parsing
  31 // Version  8: correction concerning the IF-Parsing
  32 // Version  9: end init code with LEAVE, too, if no SUB/FUNCTION follows
  33 // Version  A: #36374 at DIM AS NEW... construct variable too
  34 // Version  B: #40689 reorganized static
  35 // Version  C: #41606 bug at static
  36 // Version  D: #42678 bug at RTL-function spc
  37 // Version  E: #56204 DCREATE, to also construct arrays at DIM AS NEW
  38 // Version  F: #57844 introduction of SvNumberformat::StringToDouble
  39 // Version 10: #29955 generate for-loop-level in Statement-PCodes
  40 // Version 11: #29955 force anew compilation because of build-inconsistences
  41 // Version 12: aoo#64377 increase code size that basic can handle
  42 //             tdf#75973 support user defined types B_USERTYPES in password protected macros
  43 // Version 13: tdf#94617 store methods nStart information greater than sal_Int16 limit
  44 //
  45
  46 #define B_LEGACYVERSION 0x00000011
  47 #define B_EXT_IMG_VERSION 0x00000012
  48 #define B_CURVERSION 0x00000013
  49
  50 // The file contains either a module- or a library-record.
  51 // Those records contain further records. Every record's got
  52 // the following header:
  53
  54 //  sal_uInt16 identifier
  55 //  sal_uInt32 the record's length without the header
  56 //  sal_uInt16 number of sub-elements
  57
  58 // all the file-offsets in records are relative to the module's start!
  59
  60 enum class FileOffset {
  61     Library     =  0x4C42,      // BL Library Record
  62     Module      =  0x4D42,      // BM Module Record
  63     Name        =  0x4E4D,      // MN module name
  64     Comment     =  0x434D,      // MC comment
  65     Source      =  0x4353,      // SC source code
  66     PCode       =  0x4350,      // PC p-code
  67     OldPublics  =  0x7550,      // Pu publics
  68     Publics     =  0x5550,      // PU publics
  69     PoolDir     =  0x4450,      // PD symbol pool directory
  70     SymPool     =  0x5953,      // SY symbol pool
  71     StringPool  =  0x5453,      // ST symbol pool
  72     LineRanges  =  0x524C,      // LR line ranges for publics
  73     ModEnd      =  0x454D,      // ME module end
  74     SbxObjects  =  0x5853,      // SX SBX objects
  75     ExtSource   =  0x5345,      // ES extended source
  76     UserTypes   =  0x4369,      // UT user defined types
  77
  78     LastValue   = UserTypes
  79 };
  80
  81
  82 // A library record contains only module records
  83 //  sal_uInt16 identifier BL
  84 //  sal_uInt32 the record's length
  85 //  sal_uInt16 number of modules
  86
  87 // A module-record contains all the other record types
  88 //  sal_uInt16 identifier BM
  89 //  sal_uInt32 the record's length
  90 //  sal_uInt16 1
  91 // Data:
  92 //  sal_uInt32 version number
  93 //  sal_uInt32 character set
  94 //  sal_uInt32 starting address initialisation code
  95 //  sal_uInt32 starting address sub main
  96 //  sal_uInt32 reserved
  97 //  sal_uInt32 reserved
  98
  99 // module name, comment and source code:
 100 //  sal_uInt16 identifier MN, MC or SC
 101 //  sal_uInt32 the record's length
 102 //  sal_uInt16 1
 103 // Data:
 104 //  string instance
 105
 106 // P-Code:
 107 //  sal_uInt16 identifier PC
 108 //  sal_uInt32 the record's length
 109 //  sal_uInt16 1
 110 // Data:
 111 //  the P-Code as bytesack
 112
 113 // All symbols and strings are kept in a string-pool.
 114 // References to these strings are in this pool in the form of an index.
 115
 116 // List of all publics:
 117 //  sal_uInt16 identifier PU or Pu
 118 //  sal_uInt32 the record's length
 119 //  sal_uInt16 number of publics
 120 // Data for every public-entry:
 121 //  sal_uInt16 string index
 122 //  sal_uInt32 starting address in the p-code-image (sal_uInt16 for old publics)
 123 //  sal_uInt16 data type of the return value (from version 2)
 124
 125 // Register of the symbol tables:
 126 //  sal_uInt16 identifier SP
 127 //  sal_uInt32 the record's length
 128 //  sal_uInt16 number of symbol tables
 129 // Data for every symbol table:
 130 //  sal_uInt16 stringindex of the name
 131 //  sal_uInt16 number of symbols
 132 //  sal_uInt16 scope identifier
 133
 134 // symbol table:
 135 //  sal_uInt16 identifier SY
 136 //  sal_uInt32 the record's length
 137 //  sal_uInt16 number of symbols
 138 // Data:
 139 //  sal_uInt16 stringindex of the name
 140 //  sal_uInt16 number of symbols
 141 // Data for every symbol:
 142 //  sal_uInt16 stringindex of the name
 143 //  sal_uInt16 data type
 144 //  sal_uInt16 length for STRING*n-symbols (0x8000: STATIC variable)
 145
 146 // Stringpool:
 147 //  sal_uInt16 identifier ST
 148 //  sal_uInt32 the record's length
 149 //  sal_uInt16 number of strings
 150 // Data for every string:
 151 //  sal_uInt32 Offset in the block of all strings
 152 // the block of all strings (ASCIIZ) follows then
 153
 154 // line ranges:
 155 //  sal_uInt16 identifier LR
 156 //  sal_uInt32 the record's length
 157 //  sal_uInt16 number of strings
 158 // Data for every public:
 159 //  sal_uInt16 1st line (Sub XXX)
 160 //  sal_uInt16 2nd line (End Sub)
 161
 162 // SBX-objects:
 163 // sal_uInt16 number of objects
 164 // ...   object data
 165
 166 // user defined types B_USERTYPES :
 167 //  sal_uInt16  identifier UT
 168 //  sal_uInt32  the record's length
 169 //  sal_uInt16  number of types
 170 //  Data for every user defined type:
 171 //    string instance type name
 172 //    sal_Int16  number of type members
 173 //    Data for every type member:
 174 //      string     name
 175 //      sal_Int16 type
 176 //      sal_uInt32 flags
 177 //      sal_Int16 hasObjects (0/1)
 178 //      If hasObjects
 179 //        If member type is nested type
 180 //          string   nested type name
 181 //        Else (array declaration)
 182 //          sal_Int16  isFixedSize (0/1)
 183 //          sal_Int32  number of dimensions
 184 //          Data for every dimension:
 185 //            sal_Int32  lower bound
 186 //            sal_Int32  upper bound
 187
 188 #endif
 189
 190 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */