Glib.Convert

Entities

Constants

Subprograms

Description

Convert_Error domain for GErrors:

Bad_URI

Bad_URI           : constant := 4;

Convert

function Convert
  (Str           : String;
   To_Codeset    : String;
   From_Codeset  : String;
   Bytes_Read    : access Natural;
   Bytes_Written : access Natural;
   Error         : GError_Access := null) return Gtkada.Types.Chars_Ptr

Same as Convert procedure, but return the result as a C string.

Parameters
Str
To_Codeset
From_Codeset
Bytes_Read
Bytes_Written
Error
Return Value

Convert

function Convert
  (Str           : String;
   To_Codeset    : String;
   From_Codeset  : String;
   Error         : GError_Access := null) return String

Same as above, but return a String directly.

Parameters
Str
To_Codeset
From_Codeset
Error
Return Value

Convert

procedure Convert
  (Str           : String;
   To_Codeset    : String;
   From_Codeset  : String;
   Bytes_Read    : out Natural;
   Bytes_Written : out Natural;
   Error         : GError_Access := null;
   Result        : out String)

Convert a string from one character set to another.

Parameters
Str

String to convert

To_Codeset

Name of character set into which to convert Str

From_Codeset

Character set of Str.

Bytes_Read

Number of bytes in the input string that were successfully converted. Even if the conversion was successful, this may be less than Len if there were partial characters at the end of the input. If the error Illegal_Sequence occurs, the value stored will the byte offset after the last valid input sequence.

Bytes_Written

Number of bytes stored in the output buffer.

Error

Location to store the error occuring, ignored if null. Any of the errors in Convert_Error_Domain may occur.

Result

String converted, if no error.

Convert_Error_Domain

function Convert_Error_Domain return GQuark

Return the error domain associated with Glib.Convert.

Return Value

Escape_Text

function Escape_Text (S : String) return String

Escape the text so that it is interpreted as-is by the Pango markup language

Parameters
S
Return Value

Failed

Failed            : constant := 2;

Filename_From_URI

function Filename_From_URI
  (URI      : String;
   Hostname : access Gtkada.Types.Chars_Ptr;
   Error    : GError_Access := null) return String

Convert an escaped UTF-8 encoded URI to a local filename in the encoding used for filenames.

Parameters
URI

A uri describing a filename (escaped, encoded in UTF-8).

Hostname

Location to store hostname for the URI. If there is no hostname in the URI, null will be stored in this location.

Error

Location to store the error occuring, ignored if null. Any of the errors in Convert_Error_Domain may occur.

Return Value

Filename_From_UTF8

function Filename_From_UTF8
  (UTF8_String : String;
   Error       : GError_Access := null) return String

Convert a string from UTF-8 to the encoding used for filenames.

Parameters
UTF8_String
Error
Return Value

Filename_To_URI

function Filename_To_URI
  (Filename : String;
   Hostname : String := "";
   Error    : GError_Access := null) return String

Convert an absolute filename to an escaped UTF-8 encoded URI.

Parameters
Filename

An absolute filename specified in the encoding used for filenames by the operating system.

Hostname

A UTF-8 encoded hostname, or "" for none.

Error

Location to store the error occuring, ignored if null. Any of the errors in Convert_Error may occur.

Return Value

Filename_To_UTF8

function Filename_To_UTF8
  (OS_String : String;
   Error     : GError_Access := null) return String

Convert a string which is in the encoding used for filenames into a UTF-8 string.

Parameters
OS_String
Error
Return Value

Illegal_Sequence

Illegal_Sequence  : constant := 1;

Locale_From_UTF8

function Locale_From_UTF8 (UTF8_String : String) return String

Same as procedure Locale_From_UTF8, but return only the String.

Parameters
UTF8_String
Return Value

Locale_From_UTF8

function Locale_From_UTF8
  (UTF8_String   : String;
   Bytes_Read    : access Natural;
   Bytes_Written : access Natural;
   Error         : GError_Access := null) return Gtkada.Types.Chars_Ptr

Same as procedure Locale_From_UTF8, but return the raw C string for efficiency. The caller is responsible for freeing the resulting string. Use the C "free" function to free this.

Parameters
UTF8_String
Bytes_Read
Bytes_Written
Error
Return Value

Locale_From_UTF8

procedure Locale_From_UTF8
  (UTF8_String   : String;
   Bytes_Read    : out Natural;
   Bytes_Written : out Natural;
   Error         : GError_Access := null;
   Result        : out String)

Convert a string from UTF-8 to the encoding used for strings by the C runtime (usually the same as that used by the operating system) in the current locale.

Parameters
UTF8_String

A UTF-8 encoded string

Bytes_Read

Number of bytes in the input string that were successfully converted. Even if the conversion was successful, this may be less than Len if there were partial characters at the end of the input. If the error Illegal_Sequence occurs, the value stored will the byte offset after the last valid input sequence.

Bytes_Written

Number of bytes stored in the output buffer.

Error

Location to store the error occuring, ignored if null. Any of the errors in Convert_Error_Domain may occur.

Result

Locale_To_UTF8

function Locale_To_UTF8 (OS_String : String) return String

Same as procedure Locale_To_UTF8, but return only the String.

Parameters
OS_String
Return Value

Locale_To_UTF8

function Locale_To_UTF8
  (OS_String     : String;
   Bytes_Read    : access Natural;
   Bytes_Written : access Natural;
   Error         : GError_Access := null) return Gtkada.Types.Chars_Ptr

Same as procedure Locale_To_UTF8, but return the raw C string for efficiency. The caller is responsible for freeing the resulting string.

Parameters
OS_String
Bytes_Read
Bytes_Written
Error
Return Value

Locale_To_UTF8

procedure Locale_To_UTF8
  (OS_String     : String;
   Bytes_Read    : out Natural;
   Bytes_Written : out Natural;
   Error         : GError_Access := null;
   Result        : out String)

Convert a string which is in the encoding used for strings by the C runtime (usually the same as that used by the operating system) in the current locale into a UTF-8 string.

Parameters
OS_String

A string in the encoding of the current locale

Bytes_Read

Number of bytes in the input string that were successfully converted. Even if the conversion was successful, this may be less than Len if there were partial characters at the end of the input. If the error Illegal_Sequence occurs, the value stored will the byte offset after the last valid input sequence.

Bytes_Written

Number of bytes stored in Result.

Error

Location to store the error occuring, ignored if null. Any of the errors in Convert_Error_Domain may occur.

Result

No_Conversion

No_Conversion     : constant := 0;

Not_Absolute_Path

Not_Absolute_Path : constant := 5;

Partial_Input

Partial_Input     : constant := 3;