Inkscape::IO Namespace Reference

Low-level IO code. More...

Namespaces
namespace	Resource
namespace	Sandbox

Classes
class	BasicInputStream
	This is the class that most users should inherit, to provide their own streams. More...
class	BasicOutputStream
	This is the class that most users should inherit, to provide their own output streams. More...
class	BasicReader
	This class and its descendants are for unicode character-oriented input. More...
class	BasicWriter
	This class and its descendants are for unicode character-oriented output. More...
class	BufferInputStream
	This class is for reading character from a DOMString. More...
class	BufferOutputStream
	This class is for sending a stream to a character buffer. More...
class	FileInputStream
	This class is for receiving a stream of data from a file. More...
class	FileOutputStream
	This class is for sending a stream to a destination file. More...
class	GzipInputStream
	This class is for deflating a gzip-compressed InputStream source. More...
class	GzipOutputStream
	This class is for gzip-compressing data going to the destination OutputStream. More...
class	InputStream
	This interface is the base of all input stream classes. More...
class	InputStreamReader
	Class for placing a Reader on an open InputStream. More...
class	OutputStream
	This interface is the base of all input stream classes. More...
class	OutputStreamWriter
	Class for placing a Writer on an open OutputStream. More...
class	Reader
	This interface and its descendants are for unicode character-oriented input. More...
class	StdInputStream
	Convenience class for reading from standard input. More...
class	StdOutputStream
	Convenience class for writing to standard output. More...
class	StdReader
	Convenience class for reading formatted from standard input. More...
class	StdWriter
	Convenience class for writing to standard output. More...
class	StreamException
class	StringInputStream
	This class is for reading character from a Glib::ustring. More...
class	StringOutputStream
	This class is for sending a stream to a Glib::ustring. More...
class	TempFilename
class	Writer
	This interface and its descendants are for unicode character-oriented output. More...
class	XsltInputStream
	This class is for transforming stream input by a given stylesheet. More...
class	XsltOutputStream
	This class is for transforming stream output by a given stylesheet. More...
class	XsltStyleSheet
	This is a container for reusing a loaded stylesheet. More...

Functions
std::string	find_original_file (Glib::StdStringView const filepath, Glib::StdStringView const name)
	Takes an absolute file path and returns a second file at the same directory location, if and only if the filename exists and is a file.
void	pipeStream (InputStream &source, OutputStream &dest)
static bool	getLong (Glib::ustring &str, long *val)
static bool	getULong (Glib::ustring &str, unsigned long *val)
static bool	getDouble (Glib::ustring &str, double *val)
Writer &	operator<< (Writer &writer, char val)
Writer &	operator<< (Writer &writer, Glib::ustring &val)
Writer &	operator<< (Writer &writer, std::string &val)
Writer &	operator<< (Writer &writer, char const *val)
Writer &	operator<< (Writer &writer, bool val)
Writer &	operator<< (Writer &writer, short val)
Writer &	operator<< (Writer &writer, unsigned short val)
Writer &	operator<< (Writer &writer, int val)
Writer &	operator<< (Writer &writer, unsigned int val)
Writer &	operator<< (Writer &writer, long val)
Writer &	operator<< (Writer &writer, unsigned long val)
Writer &	operator<< (Writer &writer, float val)
Writer &	operator<< (Writer &writer, double val)
void	dump_fopen_call (char const *utf8name, char const *id)
FILE *	fopen_utf8name (char const *utf8name, char const *mode)
	Open a file with g_fopen().
bool	file_test (char const *utf8name, GFileTest test)
bool	file_is_writable (char const *utf8name)
Glib::ustring	sanitizeString (char const *str)
Glib::ustring	get_file_extension (Glib::ustring const &path)
std::string	get_file_extension (std::string const &path)
void	remove_file_extension (std::string &path)
	Removes a file extension, if found, from the given path.

Detailed Description

Low-level IO code.

This namespace contains low level IO-related code, including a homegrown streams implementation, routines for formatting SVG output, and some file handling utility functions.

Function Documentation

dump_fopen_call()

void Inkscape::IO::dump_fopen_call	(	char const *	utf8name,
		char const *	id
	)

Definition at line 37 of file sys.cpp.

Referenced by Inkscape::Extension::Internal::CairoRenderContext::_setVectorTarget(), Inkscape::Extension::Internal::PrintLatex::begin(), Inkscape::Application::crash_handler(), Inkscape::Extension::Internal::GimpGrad::open(), Inkscape::Extension::Internal::PovOutput::saveDocument(), Inkscape::Extension::Internal::LaTeXTextRenderer::setTargetFile(), sp_png_write_rgba_striped(), sp_repr_read_file(), and sp_repr_save_rebased_file().

file_is_writable()

bool Inkscape::IO::file_is_writable

(

char const *

utf8name

)

Definition at line 149 of file sys.cpp.

Referenced by Inkscape::Extension::save().

file_test()

bool Inkscape::IO::file_test	(	char const *	utf8name,
		GFileTest	test
	)

Definition at line 116 of file sys.cpp.

References test().

Referenced by FontFactory::AddFontFile(), FontFactory::AddFontsDir(), Inkscape::UI::Dialog::Export::checkOrCreateDirectory(), InkFileExportCmd::do_export(), Inkscape::IO::Resource::get_filename(), Inkscape::Extension::Internal::TemplateFromFile::new_from_template(), Inkscape::UI::Dialog::render_icon(), Inkscape::Extension::save(), sp_file_save_dialog(), sp_file_save_template(), sp_repr_read_file(), and Inkscape::UI::Dialog::Export::unConflictFilename().

find_original_file()

std::string Inkscape::IO::find_original_file	(	Glib::StdStringView const	filepath,
		Glib::StdStringView const	name
	)

Takes an absolute file path and returns a second file at the same directory location, if and only if the filename exists and is a file.

Returns the empty string if the new file is not found.

Definition at line 150 of file file.cpp.

References name.

Referenced by InkscapeApplication::document_open().

fopen_utf8name()

FILE * Inkscape::IO::fopen_utf8name	(	char const *	utf8name,
		char const *	mode
	)

Open a file with g_fopen().

Parameters

utf8name	Filename in UTF8 encoding
mode	see g_fopen()

Returns

see g_fopen()

Definition at line 72 of file sys.cpp.

References mode.

Referenced by Inkscape::Extension::Internal::CairoRenderContext::_setVectorTarget(), Inkscape::Extension::Internal::PrintLatex::begin(), Inkscape::Application::crash_handler(), Inkscape::Extension::Extension::error_file_open(), Inkscape::Extension::Internal::GimpGrad::open(), Inkscape::AutoSave::save(), Inkscape::Extension::Internal::PovOutput::saveDocument(), Inkscape::Extension::Internal::LaTeXTextRenderer::setTargetFile(), sp_file_save_backup(), sp_png_write_rgba_striped(), and sp_repr_save_rebased_file().

get_file_extension() [1/2]

Glib::ustring Inkscape::IO::get_file_extension

(

Glib::ustring const &

path

)

Definition at line 214 of file sys.cpp.

Referenced by Inkscape::Extension::Output::add_extension(), Inkscape::Extension::Effect::find_icon_file(), InkFileExportCmd::get_filename_out(), remove_file_extension(), Inkscape::UI::Dialog::ExtensionList::removeExtension(), Inkscape::UI::Dialog::ExtensionList::setExtensionFromFilename(), sp_file_save_dialog(), and Inkscape::Extension::Internal::OdfOutput::writeManifest().

get_file_extension() [2/2]

std::string Inkscape::IO::get_file_extension

(

std::string const &

path

)

Definition at line 224 of file sys.cpp.

getDouble()

static bool Inkscape::IO::getDouble ( Glib::ustring &  str, double *  val  )

static

Definition at line 241 of file inkscapestream.cpp.

References end.

Referenced by Inkscape::IO::BasicReader::readDouble(), and Inkscape::IO::BasicReader::readFloat().

getLong()

static bool Inkscape::IO::getLong ( Glib::ustring &  str, long *  val  )

static

Definition at line 219 of file inkscapestream.cpp.

References end.

Referenced by Inkscape::IO::BasicReader::readInt(), Inkscape::IO::BasicReader::readLong(), and Inkscape::IO::BasicReader::readShort().

getULong()

static bool Inkscape::IO::getULong ( Glib::ustring &  str, unsigned long *  val  )

static

Definition at line 230 of file inkscapestream.cpp.

References end.

Referenced by Inkscape::IO::BasicReader::readUnsignedInt(), Inkscape::IO::BasicReader::readUnsignedLong(), and Inkscape::IO::BasicReader::readUnsignedShort().

operator<<() [1/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		bool	val
	)

Definition at line 676 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeBool().

operator<<() [2/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		char const *	val
	)

Definition at line 673 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeString().

operator<<() [3/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		char	val
	)

Definition at line 664 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeChar().

operator<<() [4/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		double	val
	)

Definition at line 700 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeDouble().

operator<<() [5/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		float	val
	)

Definition at line 697 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeFloat().

operator<<() [6/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		Glib::ustring &	val
	)

Definition at line 667 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeUString().

operator<<() [7/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		int	val
	)

Definition at line 685 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeInt().

operator<<() [8/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		long	val
	)

Definition at line 691 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeLong().

operator<<() [9/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		short	val
	)

Definition at line 679 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeShort().

operator<<() [10/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		std::string &	val
	)

Definition at line 670 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeStdString().

operator<<() [11/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		unsigned int	val
	)

Definition at line 688 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeUnsignedInt().

operator<<() [12/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		unsigned long	val
	)

Definition at line 694 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeUnsignedLong().

operator<<() [13/13]

Writer & Inkscape::IO::operator<<	(	Writer &	writer,
		unsigned short	val
	)

Definition at line 682 of file inkscapestream.cpp.

References Inkscape::IO::Writer::writeUnsignedShort().

pipeStream()

void Inkscape::IO::pipeStream	(	InputStream &	source,
		OutputStream &	dest
	)

Definition at line 27 of file inkscapestream.cpp.

References Inkscape::IO::OutputStream::flush(), Inkscape::IO::InputStream::get(), and Inkscape::IO::OutputStream::put().

Referenced by Inkscape::IO::XsltStyleSheet::read(), and Inkscape::IO::XsltInputStream::XsltInputStream().

remove_file_extension()

void Inkscape::IO::remove_file_extension

(

std::string &

path

)

Removes a file extension, if found, from the given path.

Definition at line 233 of file sys.cpp.

References get_file_extension().

Referenced by Inkscape::UI::Dialog::BatchExport::getBatchName().

sanitizeString()

Glib::ustring Inkscape::IO::sanitizeString

(

char const *

str

)

Definition at line 183 of file sys.cpp.

References buf, and result.

Referenced by Inkscape::UI::Dialog::Export::checkOrCreateDirectory(), Inkscape::UI::Dialog::Export::exportRaster(), Inkscape::UI::Dialog::Export::exportVector(), Inkscape::AutoSave::save(), and sp_ui_error_dialog().