include/basic/sbdef.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_SBDEF_HXX
  21 #define INCLUDED_BASIC_SBDEF_HXX
  22
  23 #include <basic/sbxdef.hxx>
  24 #include <rtl/ustring.hxx>
  25 #include <basic/basicdllapi.h>
  26 #include <o3tl/typed_flags_set.hxx>
  27
  28 class ErrCode;
  29
  30 // Returns type name for Basic type, array flag is ignored
  31 // implementation: basic/source/runtime/methods.cxx
  32 BASIC_DLLPUBLIC OUString getBasicTypeName( SbxDataType eType );
  33
  34 // Returns type name for Basic objects, especially
  35 // important for SbUnoObj instances
  36 // implementation: basic/source/classes/sbunoobj.cxx
  37 class SbxObject;
  38 BASIC_DLLPUBLIC OUString getBasicObjectTypeName( SbxObject* pObj );
  39
  40 // Allows Basic IDE to set watch mode to suppress errors
  41 // implementation: basic/source/runtime/runtime.cxx
  42 BASIC_DLLPUBLIC void setBasicWatchMode( bool bOn );
  43
  44 // Debug Flags:
  45 enum class BasicDebugFlags {
  46     NONE        = 0x0000,
  47     Break       = 0x0001,        // Break-Callback
  48     StepInto    = 0x0002,        // Single Step-Callback
  49     StepOver    = 0x0004,        // Additional flag Step Over
  50     Continue    = 0x0008,        // Do not change flags
  51     StepOut     = 0x0010,        // Leave Sub
  52 };
  53 namespace o3tl {
  54     template<> struct typed_flags<BasicDebugFlags> : is_typed_flags<BasicDebugFlags, 0x001f> {};
  55 }
  56
  57 #define SBXID_BASIC         0x6273          // sb: StarBASIC
  58 #define SBXID_BASICMOD      0x6d62          // bm: StarBASIC Module
  59 #define SBXID_BASICPROP     0x7262          // pr: StarBASIC Property
  60 #define SBXID_BASICMETHOD   0x6d65          // me: StarBASIC Method
  61 #define SBXID_JSCRIPTMOD    0x6a62          // jm: JavaScript Module
  62 #define SBXID_JSCRIPTMETH   0x6a64          // jm: JavaScript Module
  63
  64 enum class PropertyMode
  65 {
  66     NONE,
  67     Get,
  68     Let,
  69     Set
  70 };
  71
  72 BASIC_DLLPUBLIC extern std::pair<const char*, ErrCode> const RID_BASIC_START[];
  73 BASIC_DLLPUBLIC std::locale BasResLocale();
  74 OUString BasResId(const char* pId);
  75
  76 #endif
  77
  78 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */