URIs and Filenames - Revision history

Speleo3: Done section

2018-12-08T14:39:06Z

Done section

← Older revision		Revision as of 14:39, 8 December 2018
Line 3:		Line 3:
	* What some variable names claim to be URIs are actually filenames and visa-versa.		* What some variable names claim to be URIs are actually filenames and visa-versa.
	* There is a lot of code duplication. (e.g. <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/dir-util.cpp src/io/dir-utils.cpp]</code> and <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/xml/rebase-hrefs.cpp src/xml/rebase-hrefs.cpp]</code>).		* There is a lot of code duplication. (e.g. <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/dir-util.cpp src/io/dir-utils.cpp]</code> and <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/xml/rebase-hrefs.cpp src/xml/rebase-hrefs.cpp]</code>).

			== Done ==

			* [https://gitlab.com/inkscape/inkscape/merge_requests/364 Merge Request !364] (<code>Inkscape::URI</code> refactoring)
			* [https://gitlab.com/inkscape/inkscape/merge_requests/437 Merge Request !437] (<code>Inkscape::URI</code> complete documentation and testing)

	== To do ==		== To do ==
Line 18:		Line 23:
	** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/uristream.h Inkscape::IO::UriInputStream]</code>		** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/uristream.h Inkscape::IO::UriInputStream]</code>
	*** Why does <code>UriInputStream</code> not decode <code>data:</code> URIs?		*** Why does <code>UriInputStream</code> not decode <code>data:</code> URIs?
	* [https://gitlab.com/inkscape/inkscape/merge_requests/364 Merge Request !364] (some <code>Inkscape::URI</code> refactoring)

	== Notes ==		== Notes ==

Tavmjong at 13:24, 24 October 2018

2018-10-24T13:24:45Z

← Older revision		Revision as of 13:24, 24 October 2018
Line 14:		Line 14:
	** Use Glib utility and conversion functions (see below).		** Use Glib utility and conversion functions (see below).
	* Remove 'sodipodi-absref' as this leaks user directory information.		* Remove 'sodipodi-absref' as this leaks user directory information.
	* Clarify whether/when to use these classes:		* Clarify whether/when to use these classes (most stuff in Inkscape::IO should probably be removed, Tav):
	** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/object/uri.h Inkscape::URI]</code>		** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/object/uri.h Inkscape::URI]</code>
	** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/uristream.h Inkscape::IO::UriInputStream]</code>		** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/uristream.h Inkscape::IO::UriInputStream]</code>

Speleo3: UriInputStream w/ data:

2018-10-24T10:14:03Z

UriInputStream w/ data:

← Older revision		Revision as of 10:14, 24 October 2018
Line 17:		Line 17:
	** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/object/uri.h Inkscape::URI]</code>		** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/object/uri.h Inkscape::URI]</code>
	** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/uristream.h Inkscape::IO::UriInputStream]</code>		** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/uristream.h Inkscape::IO::UriInputStream]</code>
			*** Why does <code>UriInputStream</code> not decode <code>data:</code> URIs?
			* [https://gitlab.com/inkscape/inkscape/merge_requests/364 Merge Request !364] (some <code>Inkscape::URI</code> refactoring)

	== Notes ==		== Notes ==

Speleo3: Inkscape::URI, Inkscape::IO::UriInputStream

2018-10-24T09:46:16Z

Inkscape::URI, Inkscape::IO::UriInputStream

← Older revision		Revision as of 09:46, 24 October 2018
Line 2:		Line 2:
	Inkscape's handling of URIs and Filenames is a complete mess!		Inkscape's handling of URIs and Filenames is a complete mess!
	* What some variable names claim to be URIs are actually filenames and visa-versa.		* What some variable names claim to be URIs are actually filenames and visa-versa.
	*There is a lot of code duplication. (e.g. src/io/dir-utils.cpp and src/xml/rebase-hrefs.cpp).		* There is a lot of code duplication. (e.g. <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/dir-util.cpp src/io/dir-utils.cpp]</code> and <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/xml/rebase-hrefs.cpp src/xml/rebase-hrefs.cpp]</code>).

	== To do ==		== To do ==

	* Put all our own URI and Filename handling code in src/io (or at least list in README in that directory).		* Put all our own URI and Filename handling code in <code>src/io</code> (or at least list in README in that directory).
	* Convert all routines to use:		* Convert all routines to use:
	** std::string for file names and paths.		** <code>std::string</code> (byte string) for file names and paths.
	** Glib::ustring for URIs		** <code>Glib::ustring</code> (unicode string) for URIs
	* Rely on Glib functions where possible. Glib functions handle many of the WIN32/LINUX/MAC issues automatically.		* Rely on Glib functions where possible. Glib functions handle many of the WIN32/LINUX/MAC issues automatically.
	** Use [http://manual.freeshell.org/glibmm-2.4/reference/html/classGio_1_1File.html Gio::File] class.		** Use [http://manual.freeshell.org/glibmm-2.4/reference/html/classGio_1_1File.html Gio::File] class.
	** Use Glib utility and conversion functions (see below).		** Use Glib utility and conversion functions (see below).
	* Remove 'sodipodi-absref' as this leaks user directory information.		* Remove 'sodipodi-absref' as this leaks user directory information.
			* Clarify whether/when to use these classes:
			** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/object/uri.h Inkscape::URI]</code>
			** <code>[https://gitlab.com/inkscape/inkscape/blob/master/src/io/uristream.h Inkscape::IO::UriInputStream]</code>

	== Notes ==		== Notes ==

	* URIs should always use '/'. You cannot use Glib filename functions to handle URIs as they will use '/' or '\' depending on operating system.		* URIs should always use '/'. You cannot use Glib filename functions to handle URIs as they will use '/' or '\' depending on operating system.
	* Use relative paths where possible as this allows moving documents with resources together.		* Use relative paths (URIs!) where possible as this allows moving documents with resources together.

	== glibmm Documentation ==		== glibmm Documentation ==

Tavmjong: Created page with " Inkscape's handling of URIs and Filenames is a complete mess! * What some variable names claim to be URIs are actually filenames and visa-versa. *There is a lot of code dupli..."

2018-10-18T11:39:03Z

Created page with " Inkscape's handling of URIs and Filenames is a complete mess! * What some variable names claim to be URIs are actually filenames and visa-versa. *There is a lot of code dupli..."

New page

Inkscape's handling of URIs and Filenames is a complete mess!
* What some variable names claim to be URIs are actually filenames and visa-versa.
*There is a lot of code duplication. (e.g. src/io/dir-utils.cpp and src/xml/rebase-hrefs.cpp).

== To do ==

* Put all our own URI and Filename handling code in src/io (or at least list in README in that directory).
* Convert all routines to use:
** std::string for file names and paths.
** Glib::ustring for URIs
* Rely on Glib functions where possible. Glib functions handle many of the WIN32/LINUX/MAC issues automatically.
** Use [http://manual.freeshell.org/glibmm-2.4/reference/html/classGio_1_1File.html Gio::File] class.
** Use Glib utility and conversion functions (see below).
* Remove 'sodipodi-absref' as this leaks user directory information.

== Notes ==

* URIs should always use '/'. You cannot use Glib filename functions to handle URIs as they will use '/' or '\' depending on operating system.
* Use relative paths where possible as this allows moving documents with resources together.

== glibmm Documentation ==

=== [http://transit.iut2.upmf-grenoble.fr/doc/glibmm-2.4/reference/html/group__MiscUtils.html Misc. Utility Functions] ===

;<nowiki>bool Glib::path_is_absolute (const std::string& filename)</nowiki>
:Returns true if the given filename is an absolute file name, i.e. it contains a full path from the root directory such as "/usr/local" on UNIX or "C:\\windows" on Windows systems. More...

;<nowiki>std::string Glib::path_skip_root (const std::string& filename)</nowiki>
:Returns the remaining part of filename after the root component, i.e. after the "/" on UNIX or "C:\\" on Windows. More...

;<nowiki>std::string Glib::path_get_basename (const std::string& filename)</nowiki>
:Gets the name of the file without any leading directory components. More...

;<nowiki>std::string Glib::path_get_dirname (const std::string& filename)</nowiki>
:Gets the directory components of a file name. More...

;<nowiki>std::string Glib::build_filename (const Glib::ArrayHandle< std::string >& elements)</nowiki>
:Creates a filename from a series of elements using the correct separator for filenames. More...

;<nowiki>std::string Glib::build_filename (const std::string& elem1, const std::string& elem2)</nowiki>
:Creates a filename from two elements using the correct separator for filenames. More...

;<nowiki>std::string Glib::build_filename (const std::string& elem1, const std::string& elem2, const std::string& elem3)</nowiki>
:Creates a filename from three elements using the correct separator for filenames. More...

etc.

=== [http://manual.freeshell.org/glibmm-2.4/reference/html/group__CharsetConv.html Conversions] ===

;<nowiki>Glib::ustring Glib::filename_to_utf8 (const std::string& opsys_string)</nowiki>
:Converts a string which is in the encoding used for filenames into a UTF-8 string.

;<nowiki>std::string Glib::filename_from_utf8 (const Glib::ustring& utf8_string)</nowiki>
:Converts a string from UTF-8 to the encoding used for filenames.

;<nowiki>std::string Glib::filename_from_uri (const Glib::ustring& uri, Glib::ustring& hostname)</nowiki>
:Converts an escaped UTF-8 encoded URI to a local filename in the encoding used for filenames.

;<nowiki>std::string Glib::filename_from_uri (const Glib::ustring& uri)</nowiki>
:Converts an escaped UTF-8 encoded URI to a local filename in the encoding used for filenames.

;<nowiki>Glib::ustring Glib::filename_to_uri (const std::string& filename, const Glib::ustring& hostname)</nowiki>
:Converts an absolute filename to an escaped UTF-8 encoded URI.

;<nowiki>Glib::ustring Glib::filename_to_uri (const std::string& filename)</nowiki>
:Converts an absolute filename to an escaped UTF-8 encoded URI.

;<nowiki>Glib::ustring Glib::filename_display_basename (const std::string& filename)</nowiki>
:Returns the display basename for the particular filename, guaranteed to be valid UTF-8.

;<nowiki>Glib::ustring Glib::filename_display_name (const std::string& filename)</nowiki>
:Converts a filename into a valid UTF-8 string.