Package org.gnome.gtksourceview

Class LanguageManager

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gtksourceview.LanguageManager

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class LanguageManager
extends GObject

Provides access to Languages.

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

Use getDefault() to retrieve the default instance of GtkSourceLanguageManager, and guessLanguage(java.lang.String, java.lang.String) to get a Language for given file name and content type.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	LanguageManager.Builder<B extends LanguageManager.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	LanguageManager.LanguageManagerClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
LanguageManager()	Creates a new language manager.
LanguageManager(MemorySegment address)	Create a LanguageManager proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	appendSearchPath(String path)	Appends path to the list of directories where the manager looks for language files.
protected LanguageManager	asParent()	Returns this instance as if it were its parent type.
static LanguageManager.Builder<? extends LanguageManager.Builder>	builder()	A LanguageManager.Builder object constructs a LanguageManager with the specified properties.
static LanguageManager	getDefault()	Returns the default GtkSourceLanguageManager instance.
Language	getLanguage(String id)	Gets the Language identified by the given id in the language manager.
String[]	getLanguageIds()	Returns the ids of the available languages.
String[]	getSearchPath()	Gets the list directories where this LanguageManager looks for language files.
static Type	getType()	Get the GType of the LanguageManager class
Language	guessLanguage(@Nullable String filename, @Nullable String contentType)	Picks a Language for given file name and content type, according to the information in lang files.
void	prependSearchPath(String path)	Prepends path to the list of directories where the manager looks for language files.
void	setSearchPath(@Nullable String[] dirs)	Sets the list of directories where the this LanguageManager looks for language files.

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getMemoryLayout, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newv, notify, notify, notifyByPspec, onNotify, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LanguageManager

public LanguageManager(MemorySegment address)

Create a LanguageManager proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

LanguageManager

public LanguageManager()

Creates a new language manager.

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

Method Details

getType

public static Type getType()

Get the GType of the LanguageManager class

Returns:

the GType

asParent

protected LanguageManager asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GObject

getDefault

public static LanguageManager getDefault()

Returns the default GtkSourceLanguageManager instance.

Returns:

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

appendSearchPath

public void appendSearchPath(String path)

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

See setSearchPath(java.lang.String[]) for details.

Parameters:

path - a directory or a filename.

getLanguage

public Language getLanguage(String id)

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

Parameters:

id - a language id.

Returns:

a GtkSourceLanguage, or null if there is no language identified by the given id. Return value is owned by this LanguageManager and should not be freed.

getLanguageIds

public String[] getLanguageIds()

Returns the ids of the available languages.

Returns:

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

getSearchPath

public String[] getSearchPath()

Gets the list directories where this LanguageManager looks for language files.

Returns:

null-terminated array containing a list of language files directories. The array is owned by this LanguageManager and must not be modified.

guessLanguage

public Language guessLanguage(@Nullable
 @Nullable String filename,
 @Nullable
 @Nullable String contentType)

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

Either filename or contentType may be null. This function can be used as follows:

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

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.getMimeTypes() and Language.getGlobs() if you need full control over file -> language mapping.

Parameters:

filename - a filename in Glib filename encoding, or null.

contentType - a content type (as in GIO API), or null.

Returns:

a GtkSourceLanguage, or null if there is no suitable language for given filename and/or contentType. Return value is owned by this LanguageManager and should not be freed.

prependSearchPath

public void prependSearchPath(String path)

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

See setSearchPath(java.lang.String[]) for details.

Parameters:

path - a directory or a filename.

setSearchPath

public void setSearchPath(@Nullable
 @Nullable String[] dirs)

Sets the list of directories where the this LanguageManager looks for language files.

If dirs is null, 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 GtkSourceLanguageManager, 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.

Parameters:

dirs - a null-terminated array of strings or null.

builder

public static LanguageManager.Builder<? extends LanguageManager.Builder> builder()

A LanguageManager.Builder object constructs a LanguageManager with the specified properties. Use the various set...() methods to set properties, and finish construction with LanguageManager.Builder.build().