Struct sourceview5::LanguageManager

pub struct LanguageManager { /* private fields */ }

Provides access to Languages.

LanguageManager is an object which processes language description files and creates and stores Language objects, and provides API to access them.

Use get_default() to retrieve the default instance of LanguageManager, and guess_language() to get a Language for given file name and content type.

Properties

language-ids

Readable

search-path

Readable | Writeable

Implements

[trait@glib::ObjectExt]

GLib type: GObject with reference counted clone semantics.

Implementations

impl LanguageManager

pub fn new() -> LanguageManager

Creates a new language manager.

If you do not need more than one language manager or a private language manager instance then use get_default() instead.

Returns

a new #GtkSourceLanguageManager.

pub fn builder() -> LanguageManagerBuilder

Creates a new builder-pattern struct instance to construct LanguageManager objects.

This method returns an instance of LanguageManagerBuilder which can be used to create LanguageManager objects.

pub fn append_search_path(&self, path: &str)

Appends @path to the list of directories where the @manager looks for language files.

See set_search_path() for details.

path

a directory or a filename.

pub fn language(&self, id: &str) -> Option<Language>

Gets the Language identified by the given @id in the language manager.

id

a language id.

Returns

a #GtkSourceLanguage, or None if there is no language identified by the given @id. Return value is owned by @self and should not be freed.

pub fn language_ids(&self) -> Vec<GString>

Returns the ids of the available languages.

Returns

a None-terminated array of strings containing the ids of the available languages or None if no language is available. The array is sorted alphabetically according to the language name. The array is owned by @self and must not be modified.

pub fn search_path(&self) -> Vec<GString>

Gets the list directories where @self looks for language files.

Returns

None-terminated array containing a list of language files directories. The array is owned by @self and must not be modified.

pub fn guess_language( &self, filename: Option<impl AsRef<Path>>, content_type: Option<&str>, ) -> Option<Language>

Picks a Language for given file name and content type, according to the information in lang files.

Either @filename or @content_type may be None. This function can be used as follows:

⚠️ The following code is in c ⚠️

GtkSourceLanguage *lang;
GtkSourceLanguageManager *manager;
lm = gtk_source_language_manager_get_default ();
lang = gtk_source_language_manager_guess_language (manager, filename, NULL);
gtk_source_buffer_set_language (buffer, lang);

or

⚠️ The following code is in c ⚠️

GtkSourceLanguage *lang = NULL;
GtkSourceLanguageManager *manager;
gboolean result_uncertain;
gchar *content_type;

content_type = g_content_type_guess (filename, NULL, 0, &result_uncertain);
if (result_uncertain)
  {
    g_free (content_type);
    content_type = NULL;
  }

manager = gtk_source_language_manager_get_default ();
lang = gtk_source_language_manager_guess_language (manager, filename, content_type);
gtk_source_buffer_set_language (buffer, lang);

g_free (content_type);

etc. Use Language::mime_types() and Language::globs() if you need full control over file -> language mapping.

filename

a filename in Glib filename encoding, or None.

content_type

a content type (as in GIO API), or None.

Returns

a #GtkSourceLanguage, or None if there is no suitable language for given @filename and/or @content_type. Return value is owned by @self and should not be freed.

pub fn prepend_search_path(&self, path: &str)

Prepends @path to the list of directories where the @manager looks for language files.

See set_search_path() for details.

path

a directory or a filename.

pub fn set_search_path(&self, dirs: &[&str])

Sets the list of directories where the @self looks for language files.

If @dirs is None, the search path is reset to default.

At the moment this function can be called only before the language files are loaded for the first time. In practice to set a custom search path for a LanguageManager, you have to call this function right after creating it.

Since GtkSourceView 5.4 this function will allow you to provide paths in the form of “resource:///” URIs to embedded GResources. They must contain the path of a directory within the GResource.

dirs

a None-terminated array of strings or None.

pub fn default() -> LanguageManager

Returns the default #GtkSourceLanguageManager instance.

Returns

a #GtkSourceLanguageManager. Return value is owned by GtkSourceView library and must not be unref’ed.

pub fn connect_language_ids_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_search_path_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

Trait Implementations

impl Clone for LanguageManager

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for LanguageManager

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LanguageManager

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for LanguageManager

type ParamSpec = ParamSpecObject

type SetValue = LanguageManager

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, LanguageManager>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for LanguageManager

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for LanguageManager

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for LanguageManager

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for LanguageManager

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for LanguageManager

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for LanguageManager

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for LanguageManager