latexila_post_processor_get_name_from_type ()

const gchar *
latexila_post_processor_get_name_from_type
                               (LatexilaPostProcessorType type);

latexila_post_processor_get_type_from_name ()

gboolean
latexila_post_processor_get_type_from_name
                               (const gchar *name,
                                LatexilaPostProcessorType *type);

latexila_post_processor_process_async ()

void
latexila_post_processor_process_async (LatexilaPostProcessor *pp,
                                       GFile *file,
                                       GInputStream *stream,
                                       GCancellable *cancellable,
                                       GAsyncReadyCallback callback,
                                       gpointer user_data);

Asynchronously process an input stream. The input stream can for example come from the output of a command launched with GSubprocess, or it can be the input stream of a file (e.g. the LaTeX log file), etc.

callback will be called when the operation is finished. You can then call latexila_post_processor_process_finish().

latexila_post_processor_process_finish ()

void
latexila_post_processor_process_finish
                               (LatexilaPostProcessor *pp,
                                GAsyncResult *result,
                                gboolean succeeded);

Finishes an operation started with latexila_post_processor_process_async(). After calling this function, you can get the filtered messages with latexila_post_processor_get_messages().

latexila_post_processor_start ()

void
latexila_post_processor_start (LatexilaPostProcessor *pp,
                               GFile *file);

Manually starts the post-processor.

Not needed if you use latexila_post_processor_process_async().

latexila_post_processor_process_line ()

void
latexila_post_processor_process_line (LatexilaPostProcessor *pp,
                                      gchar *line);

Manually processes a line. This function takes ownership of line . Free with g_free() if you don't reuse the content.

Not needed if you use latexila_post_processor_process_async().

latexila_post_processor_end ()

void
latexila_post_processor_end (LatexilaPostProcessor *pp,
                             gboolean succeeded);

Manually ends the processing.

Not needed if you use latexila_post_processor_process_async().

latexila_post_processor_get_messages ()

const GList *
latexila_post_processor_get_messages (LatexilaPostProcessor *pp,
                                      gboolean show_details);

Gets the filtered messages. Call this function only after calling latexila_post_processor_process_finish() or latexila_post_processor_end().

Another solution would have been to pass the LatexilaBuildView to the post-processor, so the filtered messages can directly be outputed to the build view as they come. But some post-processors don't know what to output directly. The latexmk post-processor can have a simplified output with only the LaTeX messages, in which case the detailed messages are also available, but this can be known only when all the stream has been processed.

Obviously if the build view is passed to the post-processor, the latexmk post-processor can output its messages only at the end. But another reason to not pass the build view is for the unit tests. It is easier for the unit tests to check the returned GList than analyzing a GtkTreeView. Of course it would be possible to keep also the messages in a GList and have this function only for the unit tests, but it takes more memory (unless a custom GtkTreeModel is implemented), or another function is needed to configure whether a GList is kept in memory or not... It becomes a little too complicated, and doesn't really worth the effort as most users use latexmk.

The current solution is "good enough". And "good enough" is... "good enough".

latexila_post_processor_take_messages ()

GQueue *
latexila_post_processor_take_messages (LatexilaPostProcessor *pp);

Takes ownership of all the messages. Since GQueue is not reference counted, pp is emptied and is thus useless after calling this function.

[skip]

LatexilaPostProcessor

typedef struct _LatexilaPostProcessor LatexilaPostProcessor;

enum LatexilaPostProcessorType

Types of post-processors.

The “has-details” property

  “has-details”              gboolean

Owner: LatexilaPostProcessor

Flags: Read / Write / Construct

Default value: FALSE