• Skip to content
• Skip to link menu

KDE 3.5 API Reference

• KDE API Reference
• API Reference

• Sitemap
• Contact Us

 

kviewshell

GURL.h

Go to the documentation of this file.

//C-  -*- C++ -*-
//C- -------------------------------------------------------------------
//C- DjVuLibre-3.5
//C- Copyright (c) 2002  Leon Bottou and Yann Le Cun.
//C- Copyright (c) 2001  AT&T
//C-
//C- This software is subject to, and may be distributed under, the
//C- GNU General Public License, Version 2. The license should have
//C- accompanied the software or you may obtain a copy of the license
//C- from the Free Software Foundation at http://www.fsf.org .
//C-
//C- This program is distributed in the hope that it will be useful,
//C- but WITHOUT ANY WARRANTY; without even the implied warranty of
//C- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//C- GNU General Public License for more details.
//C- 
//C- DjVuLibre-3.5 is derived from the DjVu(r) Reference Library
//C- distributed by Lizardtech Software.  On July 19th 2002, Lizardtech 
//C- Software authorized us to replace the original DjVu(r) Reference 
//C- Library notice by the following text (see doc/lizard2002.djvu):
//C-
//C-  ------------------------------------------------------------------
//C- | DjVu (r) Reference Library (v. 3.5)
//C- | Copyright (c) 1999-2001 LizardTech, Inc. All Rights Reserved.
//C- | The DjVu Reference Library is protected by U.S. Pat. No.
//C- | 6,058,214 and patents pending.
//C- |
//C- | This software is subject to, and may be distributed under, the
//C- | GNU General Public License, Version 2. The license should have
//C- | accompanied the software or you may obtain a copy of the license
//C- | from the Free Software Foundation at http://www.fsf.org .
//C- |
//C- | The computer code originally released by LizardTech under this
//C- | license and unmodified by other parties is deemed "the LIZARDTECH
//C- | ORIGINAL CODE."  Subject to any third party intellectual property
//C- | claims, LizardTech grants recipient a worldwide, royalty-free, 
//C- | non-exclusive license to make, use, sell, or otherwise dispose of 
//C- | the LIZARDTECH ORIGINAL CODE or of programs derived from the 
//C- | LIZARDTECH ORIGINAL CODE in compliance with the terms of the GNU 
//C- | General Public License.   This grant only confers the right to 
//C- | infringe patent claims underlying the LIZARDTECH ORIGINAL CODE to 
//C- | the extent such infringement is reasonably necessary to enable 
//C- | recipient to make, have made, practice, sell, or otherwise dispose 
//C- | of the LIZARDTECH ORIGINAL CODE (or portions thereof) and not to 
//C- | any greater extent that may be necessary to utilize further 
//C- | modifications or combinations.
//C- |
//C- | The LIZARDTECH ORIGINAL CODE is provided "AS IS" WITHOUT WARRANTY
//C- | OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
//C- | TO ANY WARRANTY OF NON-INFRINGEMENT, OR ANY IMPLIED WARRANTY OF
//C- | MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
//C- +------------------------------------------------------------------
// 
// $Id: GURL.h,v 1.9 2003/11/07 22:08:21 leonb Exp $
// $Name: release_3_5_15 $

#ifndef _GURL_H_
#define _GURL_H_
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#if NEED_GNUG_PRAGMAS
# pragma interface
#endif


#include "GString.h"
#include "Arrays.h"
#include "GThreads.h"


#ifdef HAVE_NAMESPACES
namespace DJVU {
# ifdef NOT_DEFINED // Just to fool emacs c++ mode
}
#endif
#endif


class GURL
{
public:
  class Filename;
  class UTF8;
  class Native;
protected:

   GURL(const char * url_string);

public:
   GURL(void);

   GURL(const GUTF8String & url_string);

   GURL(const GNativeString & url_string);

   GURL(const GUTF8String &xurl, const GURL &codebase);

   GURL(const GNativeString &xurl, const GURL &codebase);

   GURL(const GURL & gurl);

   virtual ~GURL(void) {}

private:
      // The 'class_lock' should be locked whenever you're accessing
      // url, or cgi_name_arr, or cgi_value_arr.
   GCriticalSection class_lock;
protected:
   GUTF8String  url;
   DArray<GUTF8String>  cgi_name_arr, cgi_value_arr;
   bool validurl;

   void     init(const bool nothrow=false);
   void     convert_slashes(void);
   void     beautify_path(void);
   static GUTF8String   beautify_path(GUTF8String url);

   static GUTF8String   protocol(const GUTF8String& url);
   void     parse_cgi_args(void);
   void     store_cgi_args(void);
public:
   bool is_valid(void) const;     // const lies to the compiler because of dependency problems

   GUTF8String  protocol(void) const;

   GUTF8String  hash_argument(void) const;

   void     set_hash_argument(const GUTF8String &arg);

   int      cgi_arguments(void) const;

   int      djvu_cgi_arguments(void) const;

   GUTF8String  cgi_name(int num) const;

   GUTF8String  djvu_cgi_name(int num) const;

   GUTF8String  cgi_value(int num) const;
   
   GUTF8String  djvu_cgi_value(int num) const;
   
   DArray<GUTF8String>cgi_names(void) const;

   DArray<GUTF8String>djvu_cgi_names(void) const;
   
   DArray<GUTF8String>cgi_values(void) const;

   DArray<GUTF8String>djvu_cgi_values(void) const;

   void     clear_all_arguments(void);

   void     clear_hash_argument(void);

   void     clear_djvu_cgi_arguments(void);

   void     clear_cgi_arguments(void);

   void     add_djvu_cgi_argument(const GUTF8String &name, const char * value=0);
   
   GURL     base(void) const;

   GUTF8String pathname(void) const;

   GUTF8String  name(void) const;

   GUTF8String  fname(void) const;

   GUTF8String  extension(void) const;

   bool     is_empty(void) const;

   bool     is_local_file_url(void) const;


//   GURL       operator+(const GUTF8String &name) const;

   bool operator==(const GURL & gurl2) const;

   bool operator!=(const GURL & gurl2) const;

   GURL &   operator=(const GURL & url);

   operator const char*(void) const { return url; };

   GUTF8String get_string(const GUTF8String &useragent) const;

   GUTF8String get_string(const bool nothrow=false) const;

   static GUTF8String encode_reserved(const GUTF8String &gs);

   static GUTF8String decode_reserved(const GUTF8String &url);

  bool is_local_path(void) const;

  bool is_file(void) const;

  bool is_dir(void) const;

  GURL follow_symlinks(void) const;

  int mkdir(void) const;

  int deletefile(void) const;

  int cleardir(const int timeout=0) const;

  int renameto(const GURL &newurl) const;

  GList<GURL> listdir(void) const;

   GUTF8String UTF8Filename(void) const;
   GNativeString NativeFilename(void) const;

   friend unsigned int  hash(const GURL & gurl);

  static GUTF8String expand_name(const GUTF8String &filename, const char *fromdirname=0);
};

class GURL::UTF8 : public GURL
{
public:
  UTF8(const GUTF8String &xurl);
  UTF8(const GUTF8String &xurl, const GURL &codebase);
};

class GURL::Native : public GURL
{
public:
  Native(const GNativeString &xurl);
  Native(const GNativeString &xurl, const GURL &codebase);
};

class GURL::Filename : public GURL
{
public:
  Filename(const GUTF8String &filename);
  Filename(const GNativeString &filename);
  class UTF8;
  class Native;
};

class GURL::Filename::UTF8 : public GURL::Filename
{
public:
  UTF8(const GUTF8String &filename);
};

class GURL::Filename::Native : public GURL::Filename
{
public:
  Native(const GNativeString &filename);
};


inline bool
GURL::operator!=(const GURL & gurl2) const
{
  return !(*this == gurl2);
}

inline GUTF8String
GURL::protocol(void) const
{
   return protocol(get_string());
}

inline bool
GURL::is_empty(void) const
{
   return !url.length()||!get_string().length();
}

// Test if the URL is valid.
// If invalid, reinitialize and return the result.
inline bool
GURL::is_valid(void) const
{
  if(!validurl)
    const_cast<GURL *>(this)->init(true);
  return validurl;
}





#ifdef HAVE_NAMESPACES
}
# ifndef NOT_USING_DJVU_NAMESPACE
using namespace DJVU;
# endif
#endif
#endif

kviewshell

Skip menu "kviewshell"

• Main Page
• Namespace List
• Class Hierarchy
• Alphabetical List
• Class List
• File List
• Namespace Members
• Class Members

API Reference

Skip menu "API Reference"

• kviewshell

Generated for API Reference by doxygen 1.5.9
This website is maintained by Adriaan de Groot and Allen Winter.
KDE^® and the K Desktop Environment^® logo are registered trademarks of KDE e.V. | Legal