ucb/source/ucp/tdoc/tdoc_uri.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: tdoc_uri.hxx,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_TDOC_URI_HXX
  32 #define INCLUDED_TDOC_URI_HXX
  33
  34 #include "rtl/ustring.hxx"
  35
  36 namespace tdoc_ucp {
  37
  38 //=========================================================================
  39
  40 #define TDOC_URL_SCHEME          "vnd.sun.star.tdoc"
  41 #define TDOC_URL_SCHEME_LENGTH   17
  42
  43 //=========================================================================
  44
  45 class Uri
  46 {
  47     enum State { UNKNOWN, INVALID, VALID };
  48
  49     mutable ::rtl::OUString m_aUri;
  50     mutable ::rtl::OUString m_aParentUri;
  51     mutable ::rtl::OUString m_aPath;
  52     mutable ::rtl::OUString m_aDocId;
  53     mutable ::rtl::OUString m_aInternalPath;
  54     mutable ::rtl::OUString m_aName;
  55     mutable ::rtl::OUString m_aDecodedName;
  56     mutable State           m_eState;
  57
  58 private:
  59     void init() const;
  60
  61 public:
  62     Uri() : m_eState( UNKNOWN ) {}
  63     Uri( const ::rtl::OUString & rUri )
  64     : m_aUri( rUri ), m_eState( UNKNOWN ) {}
  65
  66     bool operator== ( const Uri & rOther ) const
  67     { init(); return m_aUri == rOther.m_aUri; }
  68
  69     bool operator!= ( const Uri & rOther ) const
  70     { return !operator==( rOther ); }
  71
  72     sal_Bool isValid() const
  73     { init(); return m_eState == VALID; }
  74
  75     const ::rtl::OUString & getUri() const
  76     { init(); return m_aUri; }
  77
  78     inline void setUri( const ::rtl::OUString & rUri );
  79
  80     const ::rtl::OUString & getParentUri() const
  81     { init(); return m_aParentUri; }
  82
  83     const ::rtl::OUString & getPath() const
  84     { init(); return m_aPath; }
  85
  86     const ::rtl::OUString & getDocumentId() const
  87     { init(); return m_aDocId; }
  88
  89     const ::rtl::OUString & getInternalPath() const
  90     { init(); return m_aInternalPath; }
  91
  92     const ::rtl::OUString & getName() const
  93     { init(); return m_aName; }
  94
  95     const ::rtl::OUString & getDecodedName() const
  96     { init(); return m_aDecodedName; }
  97
  98     inline sal_Bool isRoot() const;
  99
 100     inline sal_Bool isDocument() const;
 101
 102     inline sal_Bool isFolder() const;
 103 };
 104
 105 inline void Uri::setUri( const ::rtl::OUString & rUri )
 106 {
 107     m_eState = UNKNOWN;
 108     m_aUri = rUri;
 109     m_aParentUri = m_aDocId = m_aInternalPath = m_aPath = m_aName
 110         = m_aDecodedName = rtl::OUString();
 111 }
 112
 113 inline sal_Bool Uri::isRoot() const
 114 {
 115     init();
 116     return ( m_aPath.getLength() == 1 );
 117 }
 118
 119 inline sal_Bool Uri::isDocument() const
 120 {
 121     init();
 122     return ( ( m_aDocId.getLength() > 0 ) /* not root */
 123              && ( m_aPath.copy( m_aDocId.getLength() + 1 ).getLength() < 2 ) );
 124 }
 125
 126 inline sal_Bool Uri::isFolder() const
 127 {
 128     init();
 129     return ( m_aPath.lastIndexOf( '/' ) == m_aPath.getLength() - 1 );
 130 }
 131
 132 } // namespace tdoc_ucp
 133
 134 #endif /* !INCLUDED_TDOC_URI_HXX */