sal/osl/w32/path_helper.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_SAL_OSL_W32_PATH_HELPER_HXX
  21 #define INCLUDED_SAL_OSL_W32_PATH_HELPER_HXX
  22
  23 #include <sal/config.h>
  24
  25 #include <osl/diagnose.h>
  26 #include <osl/file.h>
  27 #include <rtl/alloc.h>
  28 #include <rtl/ustring.h>
  29 #include <rtl/ustring.hxx>
  30 #include <sal/types.h>
  31
  32 /**
  33  Adds a trailing path separator to the given system path if not
  34  already there and if the path is not the root path or a logical
  35  drive alone
  36 */
  37
  38 void osl_systemPathEnsureSeparator(/*inout*/ rtl_uString** ppustrPath);
  39
  40 /**
  41  Removes the last separator from the given system path if any and
  42  if the path is not the root path '\'
  43 */
  44
  45 void osl_systemPathRemoveSeparator(/*inout*/ rtl_uString** ppustrPath);
  46
  47 /**
  48  Returns whether a given path is only a logical drive pattern or not.
  49  A logical drive pattern is something like "a:\", "c:\".
  50  No logical drive pattern is something like "c:\test"
  51 */
  52
  53 bool osl_systemPathIsLogicalDrivePattern(/*in*/ const rtl_uString* pustrPath);
  54
  55 namespace osl
  56 {
  57
  58 /**
  59  Adds a trailing path separator to the given system path if not
  60  already there and if the path is not the root path or a logical
  61  drive alone
  62 */
  63
  64 inline void systemPathEnsureSeparator(/*inout*/ OUString& Path)
  65 {
  66     osl_systemPathEnsureSeparator(&Path.pData);
  67 }
  68
  69 /**
  70  Removes the last separator from the given system path if any and
  71  if the path is not the root path '\'
  72 */
  73
  74 inline void systemPathRemoveSeparator(/*inout*/ OUString& Path)
  75 {
  76     osl_systemPathRemoveSeparator(&Path.pData);
  77 }
  78
  79 inline bool systemPathIsLogicalDrivePattern(/*in*/ const OUString& path)
  80 {
  81     return osl_systemPathIsLogicalDrivePattern(path.pData);
  82 }
  83
  84 template< class T >
  85 class LongPathBuffer
  86 {
  87     T* m_pBuffer;
  88     sal_uInt32 m_nCharNum;
  89
  90     LongPathBuffer();
  91     LongPathBuffer( const LongPathBuffer& );
  92     LongPathBuffer& operator=( const LongPathBuffer& );
  93
  94 public:
  95     explicit LongPathBuffer( sal_uInt32 nCharNum )
  96     : m_pBuffer( static_cast<T*>( malloc( nCharNum * sizeof( T ) ) ) )
  97     , m_nCharNum( nCharNum )
  98     {
  99         OSL_ENSURE( m_pBuffer, "Can not allocate the buffer!" );
 100     }
 101
 102     ~LongPathBuffer()
 103     {
 104         if ( m_pBuffer )
 105             free( m_pBuffer );
 106         m_pBuffer = nullptr;
 107     }
 108
 109     sal_uInt32 getBufSizeInSymbols()
 110     {
 111         return m_nCharNum;
 112     }
 113
 114     operator T* ()
 115     {
 116         return m_pBuffer;
 117     }
 118
 119 };
 120
 121 } // end namespace osl
 122
 123 #endif
 124
 125 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */