/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_OOX_OLE_VBAHELPER_HXX
#define INCLUDED_OOX_OLE_VBAHELPER_HXX
#include <oox/helper/binarystreambase.hxx>
#include <rtl/ustring.hxx>
#include <sal/types.h>
namespace oox {
class BinaryInputStream; }
namespace oox::ole {
// Directory stream record identifiers ========================================
const sal_uInt16 VBA_ID_MODULECOOKIE = 0x002C;
const sal_uInt16 VBA_ID_MODULEDOCSTRING = 0x001C;
const sal_uInt16 VBA_ID_MODULEDOCSTRINGUNICODE = 0x0048;
const sal_uInt16 VBA_ID_MODULEEND = 0x002B;
const sal_uInt16 VBA_ID_MODULEHELPCONTEXT = 0x001E;
const sal_uInt16 VBA_ID_MODULENAME = 0x0019;
const sal_uInt16 VBA_ID_MODULENAMEUNICODE = 0x0047;
const sal_uInt16 VBA_ID_MODULEOFFSET = 0x0031;
const sal_uInt16 VBA_ID_MODULEPRIVATE = 0x0028;
const sal_uInt16 VBA_ID_MODULEREADONLY = 0x0025;
const sal_uInt16 VBA_ID_MODULESTREAMNAME = 0x001A;
const sal_uInt16 VBA_ID_MODULESTREAMNAMEUNICODE = 0x0032;
const sal_uInt16 VBA_ID_MODULETYPEDOCUMENT = 0x0022;
const sal_uInt16 VBA_ID_MODULETYPEPROCEDURAL = 0x0021;
const sal_uInt16 VBA_ID_PROJECTCODEPAGE = 0x0003;
const sal_uInt16 VBA_ID_PROJECTEND = 0x0010;
const sal_uInt16 VBA_ID_PROJECTMODULES = 0x000F;
const sal_uInt16 VBA_ID_PROJECTNAME = 0x0004;
const sal_uInt16 VBA_ID_PROJECTVERSION = 0x0009;
/** Static helper functions for the VBA filters. */
namespace VbaHelper
{
/** Reads the next record from the VBA directory stream 'dir'.
@param rnRecId (out parameter) The record identifier of the new record.
@param rRecData (out parameter) The contents of the new record.
@param rInStrm The 'dir' stream.
@return True = next record successfully read. False on any error, or
if the stream is EOF.
*/
bool readDirRecord(
sal_uInt16& rnRecId,
StreamDataSequence& rRecData,
BinaryInputStream& rInStrm );
/** Extracts a key/value pair from a string separated by an equality sign.
@param rKey (out parameter) The key before the separator.
@param rValue (out parameter) The value following the separator.
@param rCodeLine The source key/value pair.
@return True = Equality sign separator found, and the returned key and
value are not empty. False otherwise.
*/
bool extractKeyValue(
OUString& rKey,
OUString& rValue,
std::u16string_view rKeyValue );
}
}
// namespace oox::ole
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
