Extractor

static class · namespace z3n7.Tools · source Tools/Extractor.cs

public static class Extractor

Reading and writing ZennoPoster project files (.zp) through ProjectMaker's own loader, and searching their actions. Works only inside ProjectMaker: it uses the ProjectMaker assembly loaded in the process and does nothing elsewhere.

Methods#

BuildZpFromXml#

public static void BuildZpFromXml(this IZennoPosterProjectModel project, string xml = null, string zpPath = null)

Extension method for IZennoPosterProjectModel. source

Builds a .zp file from project XML, using the current project file as the container.

ExtractInputSettingsHtml#

public static string ExtractInputSettingsHtml(string zpPath)

source

Reads the input settings HTML (InputSettings/inputSettings.html) of a .zp file.

Returns: The HTML without BOM; null outside ProjectMaker.

ExtractXml#

public static string ExtractXml(string zpPath)

source

Unpacks the project XML of a .zp file.

Returns: The XML; the loader's exception text when it fails; null outside ProjectMaker.

SaveAsXml#

public static void SaveAsXml(this IZennoPosterProjectModel project, string xmlPath = null)

Extension method for IZennoPosterProjectModel. source

Unpacks the current project to XML (UTF-16).

SaveInputSettingsHtml#

public static void SaveInputSettingsHtml(string zpPath, string html)

source

Replaces the input settings HTML inside the .zp file itself.

public static void SaveInputSettingsHtml(string zpPath, string html, string outputZpPath)

source

Writes a copy of the .zp file with the input settings HTML replaced. When the output is the source file, it is written through a temporary file.

SearchInZp#

public static List<SearchHit> SearchInZp(this IZennoPosterProjectModel project, string text, string folder = null, bool recursive = true, bool cache = true, int padding = 60)

Extension method for IZennoPosterProjectModel. source

Finds text in the actions of every .zp file in a folder (case-insensitive, in attributes and values; XML entities are decoded for matching). One hit per action; each hit is also written to the log. Unpacking takes about a second per file, so unpacked XML can be cached in a hidden .xml folder; the cache file name holds the project's modification time and size, so a changed project is re-read automatically.

Remarks: Works only inside ProjectMaker: it uses the ProjectMaker assembly loaded in the process and does nothing elsewhere.