uri.h

Go to the documentation of this file.

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _LIBGNOMEVFSMM_URI_H
#define _LIBGNOMEVFSMM_URI_H
 
 
#include <glibmm.h>
 
/* $Id: uri.hg,v 1.20 2006/10/31 09:06:50 murrayc Exp $ */
// -*- C++ -*- // this is for the .hg, I realize gensig puts one in
 
/* Copyright 2003 gnome-vfsmm Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
 
#include <libgnomevfsmm/file-info.h>
#include <libgnomevfsmm/enums.h>
#include <libgnomevfsmm/exception.h>
#include <libgnomevfs/gnome-vfs-uri.h>
#include <libgnomevfs/gnome-vfs-ops.h>
 
 
namespace Gnome
{
 
namespace Vfs
{
 
enum MakeURIDirs
{
  MAKE_URI_DIR_NONE = 0,
  MAKE_URI_DIR_HOMEDIR = 1 << 0,
  MAKE_URI_DIR_CURRENT = 1 << 1
};
 
inline MakeURIDirs operator|(MakeURIDirs lhs, MakeURIDirs rhs)
  { return static_cast<MakeURIDirs>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs)); }
 
inline MakeURIDirs operator&(MakeURIDirs lhs, MakeURIDirs rhs)
  { return static_cast<MakeURIDirs>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs)); }
 
inline MakeURIDirs operator^(MakeURIDirs lhs, MakeURIDirs rhs)
  { return static_cast<MakeURIDirs>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs)); }
 
inline MakeURIDirs operator~(MakeURIDirs flags)
  { return static_cast<MakeURIDirs>(~static_cast<unsigned>(flags)); }
 
inline MakeURIDirs& operator|=(MakeURIDirs& lhs, MakeURIDirs rhs)
  { return (lhs = static_cast<MakeURIDirs>(static_cast<unsigned>(lhs) | static_cast<unsigned>(rhs))); }
 
inline MakeURIDirs& operator&=(MakeURIDirs& lhs, MakeURIDirs rhs)
  { return (lhs = static_cast<MakeURIDirs>(static_cast<unsigned>(lhs) & static_cast<unsigned>(rhs))); }
 
inline MakeURIDirs& operator^=(MakeURIDirs& lhs, MakeURIDirs rhs)
  { return (lhs = static_cast<MakeURIDirs>(static_cast<unsigned>(lhs) ^ static_cast<unsigned>(rhs))); }
 
 
class Uri
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef Uri CppObjectType;
  typedef GnomeVFSURI BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
 
 
  // For use with Glib::RefPtr<> only.
  void reference()   const;
  void unreference() const;
 
  GnomeVFSURI*       gobj();
 
  const GnomeVFSURI* gobj() const;
 
  GnomeVFSURI* gobj_copy() const;
 
protected:
  // Do not derive this.  Gnome::Vfs::Uri can neither be constructed nor deleted.
  Uri();
  void operator delete(void*, size_t);
 
private:
  // noncopyable
  Uri(const Uri&);
  Uri& operator=(const Uri&);
 
 
public:
 
  static Glib::RefPtr<Uri> create(const Glib::ustring& uri);
 
  
  Glib::RefPtr<Uri> resolve_relative(const Glib::ustring& relative_reference);
 
 
  Glib::RefPtr<Uri> append_string(const Glib::ustring& uri_fragment);
  
  Glib::RefPtr<Uri> append_path(const Glib::ustring& path);
  
  Glib::RefPtr<Uri> append_file_name(const Glib::ustring& filename);
  
  Glib::ustring to_string(URIHideOptions hide_options = URI_HIDE_NONE) const;
  
  Glib::RefPtr<Uri> dup();
  
  bool is_local() const;
  
  bool has_parent() const;
  
  Glib::RefPtr<Uri> get_parent();
  
  Glib::RefPtr<const Uri> get_parent() const;
 
  //TODO: GnomeVFSToplevelURI inherits from GnomeVFSUri, but they are not GObjects. That needs a little work.  
  //_WRAP_METHOD(GnomeVFSToplevelURI* get_toplevel(), gnome_vfs_uri_get_toplevel)
  //_WRAP_METHOD(const GnomeVFSToplevelURI* get_toplevel() const, gnome_vfs_uri_get_toplevel)
 
  
  Glib::ustring get_host_name() const;
  
  Glib::ustring get_scheme() const;
  
  guint get_host_port() const;
  
  Glib::ustring get_user_name() const;
  
  Glib::ustring get_password() const;
 
  
  void set_host_name(const Glib::ustring& host_name);
  
  void set_host_port(guint host_port);
  
  void set_user_name(const Glib::ustring& user_name);
  
  void set_password(const Glib::ustring& password);
 
  
  bool equal(const Glib::RefPtr<const Uri>& uri) const;
  //We wrap this as equal() as well, because operator== requires an operator*.
  
 
  bool is_parent(const Glib::RefPtr<const Uri>& possible_child, bool recursive = true) const;
 
  
  Glib::ustring get_path() const;
  
  Glib::ustring get_fragment_identifier() const;
  
  Glib::ustring extract_dirname() const;
  
  Glib::ustring extract_short_name() const;
  
  Glib::ustring extract_short_path_name() const;
 
  //These are used for creating hashes for hash tables, apparently.
  //I don't see the point of wrapping them.
  
 
/*
GList* gnome_vfs_uri_list_parse(const Glib::ustring& uri_list), )
*/
 
  
  static Glib::ustring make_full_from_relative(const Glib::ustring& base_uri, const Glib::ustring& relative_uri);
 
  
  static Glib::ustring format_for_display(const Glib::ustring& uri);
  
  static Glib::ustring make_from_input(const Glib::ustring& uri);
  
  static Glib::ustring make_from_input(const Glib::ustring& uri, MakeURIDirs dirs);
  
  static Glib::ustring make_canonical_strip_fragment(const Glib::ustring& uri);
  
  static bool uris_match(const Glib::ustring& uri_1, const Glib::ustring& uri_2);
  
  static Glib::ustring get_scheme(const Glib::ustring& uri);
  
  static Glib::ustring make_from_shell_arg(const Glib::ustring& uri);
 
 
  #ifdef GLIBMM_EXCEPTIONS_ENABLED
  Glib::RefPtr<FileInfo> get_file_info(FileInfoOptions options = FILE_INFO_DEFAULT) const throw(exception);
  #else
  Glib::RefPtr<FileInfo> get_file_info(FileInfoOptions options, std::auto_ptr<Gnome::Vfs::exception>& error) const;
  #endif
 
  #ifdef GLIBMM_EXCEPTIONS_ENABLED
  void create_symbolic_link(const Glib::ustring& target_reference) throw(exception);
  #else
  void create_symbolic_link(const Glib::ustring& target_reference, std::auto_ptr<Gnome::Vfs::exception>& error);
  #endif
 
  bool uri_exists() const;
 
  #ifdef GLIBMM_EXCEPTIONS_ENABLED
  FileSize get_volume_free_space() const throw(exception);        
  #else
  FileSize get_volume_free_space(std::auto_ptr<Gnome::Vfs::exception>& error) const;
  #endif
 
 
};
 
 
//TODO: GnomeVFSToplevelURI inherits from GnomeVFSUri, but they are not GObjects. That needs a little work.
/*
class TopLevelUri : Uri
{
  //TODO: Constructors/memory-management so we can wrap a GnomeVFSToplevelURI* in this.
  //TODO: member accessors?
};
*/
  
 
} // namespace Vfs
} // namespace Gnome
 
 
namespace Gnome
{
 
namespace Vfs
{
 
bool operator==(const Uri& lhs, const Uri& rhs);
 
bool operator!=(const Uri& lhs, const Uri& rhs);
 
 
} // namespace Vfs
 
} // namespace Gnome
 
 
namespace Glib
{
 
  Glib::RefPtr<Gnome::Vfs::Uri> wrap(GnomeVFSURI* object, bool take_copy = false);
 
} // namespace Glib
 
 
#endif /* _LIBGNOMEVFSMM_URI_H */