include/codemaker/global.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_CODEMAKER_GLOBAL_HXX
  21 #define INCLUDED_CODEMAKER_GLOBAL_HXX
  22
  23 #include <list>
  24 #include <vector>
  25 #include <set>
  26
  27 #include <stdio.h>
  28
  29 #include "osl/file.hxx"
  30 #include "rtl/ustring.hxx"
  31 #include "rtl/strbuf.hxx"
  32
  33 struct EqualString
  34 {
  35     sal_Bool operator()(const ::rtl::OString& str1, const ::rtl::OString& str2) const
  36     {
  37         return (str1 == str2);
  38     }
  39 };
  40
  41 struct HashString
  42 {
  43     size_t operator()(const ::rtl::OString& str) const
  44     {
  45         return str.hashCode();
  46     }
  47 };
  48
  49 struct LessString
  50 {
  51     sal_Bool operator()(const ::rtl::OString& str1, const ::rtl::OString& str2) const
  52     {
  53         return (str1 < str2);
  54     }
  55 };
  56
  57 typedef ::std::list< ::rtl::OString >               StringList;
  58 typedef ::std::vector< ::rtl::OString >             StringVector;
  59 typedef ::std::set< ::rtl::OString, LessString >    StringSet;
  60
  61 //*************************************************************************
  62 // FileStream
  63 //*************************************************************************
  64 enum FileAccessMode
  65 {
  66     FAM_READ,                   // "r"
  67     FAM_WRITE,                  // "w"
  68     FAM_READWRITE_EXIST,        // "r+"
  69     FAM_READWRITE               // "w+"
  70 };
  71
  72 class FileStream
  73 {
  74 public:
  75     FileStream();
  76     virtual ~FileStream();
  77
  78     sal_Bool isValid();
  79
  80     void createTempFile(const ::rtl::OString& sPath);
  81     void close();
  82
  83     ::rtl::OString  getName() { return m_name; }
  84
  85     bool write(void const * buffer, sal_uInt64 size);
  86
  87     // friend functions
  88     friend FileStream &operator<<(FileStream& o, sal_uInt32 i);
  89     friend FileStream &operator<<(FileStream& o, char const * s);
  90     friend FileStream &operator<<(FileStream& o, ::rtl::OString* s);
  91     friend FileStream &operator<<(FileStream& o, const ::rtl::OString& s);
  92     friend FileStream &operator<<(FileStream& o, ::rtl::OStringBuffer* s);
  93     friend FileStream &operator<<(FileStream& o, const ::rtl::OStringBuffer& s);
  94     friend FileStream & operator <<(FileStream & out, rtl::OUString const & s);
  95
  96 private:
  97     oslFileHandle m_file;
  98     ::rtl::OString  m_name;
  99 };
 100
 101
 102 //*************************************************************************
 103 // Helper functions
 104 //*************************************************************************
 105 ::rtl::OString getTempDir(const ::rtl::OString& sFileName);
 106
 107 ::rtl::OString createFileNameFromType(const ::rtl::OString& destination,
 108                                       const ::rtl::OString type,
 109                                       const ::rtl::OString postfix,
 110                                       sal_Bool bLowerCase=sal_False,
 111                                       const ::rtl::OString prefix="");
 112
 113 sal_Bool fileExists(const ::rtl::OString& fileName);
 114 sal_Bool makeValidTypeFile(const ::rtl::OString& targetFileName,
 115                            const ::rtl::OString& tmpFileName,
 116                            sal_Bool bFileCheck);
 117 sal_Bool removeTypeFile(const ::rtl::OString& fileName);
 118
 119 ::rtl::OUString convertToFileUrl(const ::rtl::OString& fileName);
 120
 121 class CannotDumpException {
 122 public:
 123     CannotDumpException(OUString const & message): message_(message) {}
 124
 125     virtual ~CannotDumpException() throw ();
 126
 127     OUString getMessage() const { return message_; }
 128
 129 private:
 130     OUString message_;
 131 };
 132
 133 #endif // INCLUDED_CODEMAKER_GLOBAL_HXX
 134
 135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */