kurl.h

/* This file is part of the KDE libraries
 *  Copyright (C) 1999 Torben Weis <weis@kde.org>
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public License
 *  along with this library; see the file COPYING.LIB.  If not, write to
 *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 *  Boston, MA 02110-1301, USA.
 **/
 
#ifndef __kurl_h__
#define __kurl_h__
 
#include <tqstring.h>
#include <tqvaluelist.h>
#include "tdelibs_export.h"
 
class TQUrl;
class TQStringList;
template <typename K, typename V> class TQMap;
 
class KURLPrivate;
 
// Defines that file-urls look like file:///path/file instead of file:/path/file
#define KURL_TRIPLE_SLASH_FILE_PROT
 
class TDECORE_EXPORT KURL
{
public:
  enum AdjustementFlags
  {
    NoAdjustements = 0,
    StripFileProtocol = 1
  };
 
  enum URIMode
  {
    Auto,
    Invalid,
    RawURI,
    URL,
    Mailto
  };
 
  class TDECORE_EXPORT List : public TQValueList<KURL>
  {
  public:
      List() { }
      List(const KURL &url);
      List(const TQStringList &list);
      TQStringList toStringList() const;
  };
  KURL();
 
  ~KURL();
 
  KURL( const TQString& url, int encoding_hint = 0 );
  KURL( const char * url, int encoding_hint = 0 );
  KURL( const TQCString& url, int encoding_hint = 0 );
 
  KURL( const KURL& u );
  KURL( const TQUrl &u );
  KURL( const KURL& _baseurl, const TQString& _rel_url, int encoding_hint=0 );
 
  TQString protocol() const { return m_bIsMalformed ? TQString::null : m_strProtocol; }
  void setProtocol( const TQString& _txt );
 
  int uriMode() const;
 
  TQString user() const { return m_strUser; }
  void setUser( const TQString& _txt );
  bool hasUser() const { return !m_strUser.isEmpty(); }
 
  TQString pass() const { return m_strPass; }
  void setPass( const TQString& _txt );
  bool hasPass() const { return !m_strPass.isEmpty(); }
 
  TQString host() const { return m_strHost; }
 
  void setHost( const TQString& _txt );
  bool hasHost() const { return !m_strHost.isEmpty(); }
 
  unsigned short int port() const { return m_iPort; }
  void setPort( unsigned short int _p );
 
  TQString path() const  { return m_strPath; }
 
  TQString path( int _trailing ) const;
 
  void setPath( const TQString& path );
 
  bool hasPath() const { return !m_strPath.isEmpty(); }
 
  void setInternalReferenceURL( const TQString& url );
 
  TQString internalReferenceURL( void ) const;
 
  void cleanPath(bool cleanDirSeparator = true);
 
  void adjustPath(int _trailing);
 
  void setEncodedPathAndQuery( const TQString& _txt, int encoding_hint = 0 );
 
  void setEncodedPath(const TQString& _txt, int encoding_hint = 0 );
 
  TQString encodedPathAndQuery( int _trailing = 0, bool _no_empty_path = false, int encoding_hint = 0) const;
 
  void setQuery( const TQString& _txt, int encoding_hint = 0);
 
  TQString query() const;
 
  TQString ref() const { return m_strRef_encoded; }
 
  void setRef( const TQString& _txt ) { m_strRef_encoded = _txt; }
 
  bool hasRef() const { return !m_strRef_encoded.isNull(); }
 
  TQString htmlRef() const;
 
  TQString encodedHtmlRef() const;
 
  void setHTMLRef( const TQString& _ref );
 
  bool hasHTMLRef() const;
 
  bool isValid() const  { return !m_bIsMalformed; }
  TDE_DEPRECATED bool isMalformed() const { return !isValid(); }
 
  bool isLocalFile() const;
 
  void setFileEncoding(const TQString &encoding);
 
  TQString fileEncoding() const;
 
  bool hasSubURL() const;
 
  void addPath( const TQString& txt );
 
  TQString queryItem( const TQString& item ) const;
 
  TQString queryItem( const TQString& item, int encoding_hint ) const;
 
  enum QueryItemsOptions
  {
    CaseInsensitiveKeys = 1
  };
 
  TQMap< TQString, TQString > queryItems( int options=0 ) const;
 
  TQMap< TQString, TQString > queryItems( int options, int encoding_hint ) const;
 
  void addQueryItem( const TQString& _item, const TQString& _value, int encoding_hint = 0 );
 
  void removeQueryItem( const TQString& _item );
 
  void setFileName( const TQString&_txt );
 
  TQString fileName( bool _ignore_trailing_slash_in_path = true ) const;
 
  TQString directory( bool _strip_trailing_slash_from_result = true,
             bool _ignore_trailing_slash_in_path = true ) const;
 
  void setDirectory(const TQString &dir);
 
  bool cd( const TQString& _dir );
 
  TQString url( int _trailing = 0, int encoding_hint = 0) const;
 
  TQString prettyURL( int _trailing = 0) const;
 
  TQString prettyURL( int _trailing, AdjustementFlags _flags) const;
  // ### BIC: Merge the two above + spell it as "Adjustment"
  // Or remove completely, and let people use pathOrURL() instead
 
  TQString pathOrURL() const;
 
  TQString htmlURL() const;
 
 
  bool isEmpty() const;
 
  KURL upURL( ) const;
 
  bool operator<(const KURL& _u) const;
 
  KURL& operator=( const KURL& _u );
 
  KURL& operator=( const TQString& _url );
 
  KURL& operator=( const char * _url );
 
  KURL& operator=( const TQUrl & u );
 
  bool operator==( const KURL& _u ) const;
 
  bool operator==( const TQString& _u ) const;
 
  bool operator!=( const KURL& _u ) const { return !( *this == _u ); }
 
  bool operator!=( const TQString& _u ) const { return !( *this == _u ); }
 
  bool cmp( const KURL &u, bool ignore_trailing = false ) const TDE_DEPRECATED;
 
  bool equals( const KURL &u, bool ignore_trailing = false ) const;
 
  bool equals( const KURL &u, bool ignore_trailing, bool ignore_internalReferenceURLS ) const; // TODO KDE4: add bool _ignore_ref = false
 
  bool isParentOf( const KURL& u ) const;
 
  static List split( const TQString& _url );
 
  static List split( const KURL& _url );
 
  static KURL join( const List& _list );
 
  static KURL fromPathOrURL( const TQString& text );
 
  static TQString encode_string(const TQString &str, int encoding_hint = 0);
 
  static TQString encode_string_no_slash(const TQString &str, int encoding_hint = 0);
 
  static TQString decode_string(const TQString &str, int encoding_hint = 0);
 
  static bool isRelativeURL(const TQString &_url);
 
  static TQString relativeURL(const KURL &base_url, const KURL &url, int encoding_hint = 0);
 
  static TQString relativePath(const TQString &base_dir, const TQString &path, bool *isParent=0);
 
  static URIMode uriModeForProtocol(const TQString& protocol);
 
#ifdef KDE_NO_COMPAT
private:
#endif
    TQString filename( bool _ignore_trailing_slash_in_path = true ) const
  {
    return fileName(_ignore_trailing_slash_in_path);
  }
 
protected:
  void reset();
  
  void parseURL( const TQString& _url, int encoding_hint = 0 );
  void parseRawURI( const TQString& _url, int encoding_hint = 0 );
  void parseMailto( const TQString& _url, int encoding_hint = 0 );
  void parse( const TQString& _url, int encoding_hint = 0 );
 
private:
  void _setQuery( const TQString& _txt, int encoding_hint = 0);
 
  TQString m_strProtocol;
  TQString m_strUser;
  TQString m_strPass;
  TQString m_strHost;
  TQString m_strPath;
  TQString m_strRef_encoded;
  TQString m_strQuery_encoded;
  bool m_bIsMalformed : 1;
  enum URIMode m_iUriMode : 3;
  uint freeForUse     : 4;
  unsigned short int m_iPort;
  TQString m_strPath_encoded;
 
  friend TDECORE_EXPORT TQDataStream & operator<< (TQDataStream & s, const KURL & a);
  friend TDECORE_EXPORT TQDataStream & operator>> (TQDataStream & s, KURL & a);
private:
  KURLPrivate* d;
};
 
TDECORE_EXPORT bool urlcmp( const TQString& _url1, const TQString& _url2 );
 
TDECORE_EXPORT bool urlcmp( const TQString& _url1, const TQString& _url2, bool _ignore_trailing, bool _ignore_ref );
 
TDECORE_EXPORT TQDataStream & operator<< (TQDataStream & s, const KURL & a);
TDECORE_EXPORT TQDataStream & operator>> (TQDataStream & s, KURL & a);
 
#endif