RC1 v2.0.4

Author: tig

README.md

@@ -18,15 +18,15 @@ PS > out-winprint -verbose
 VERBOSE: Out-WinPrint 2.0.3.0 - Copyright Kindel Systems, LLC - https://tig.github.io/winprint
 ```
 
-Print `Program.cs` using the default sheet definition and default printer:
+Print a Powershell profile using the default sheet definition and default printer:
 
 ```powershell
-get-content Program.cs | out-winprint
+Get-Content $profile.CurrentUserAllHosts | winprint -Language powershell
 ```
 
 ```powershell
 PS > cat Program.cs | wp -PrinterName PDF -Orientation Portrait -Verbose -Title Program.cs
-VERBOSE: Out-WinPrint 2.0.3.0 - Copyright Kindel Systems, LLC - https://tig.github.io/winprint
+VERBOSE: Out-WinPrint 2.0.4.0 - Copyright Kindel Systems, LLC - https://tig.github.io/winprint
 VERBOSE:     Printer:          PDF
 VERBOSE:     Paper Size:       Letter
 VERBOSE:     Orientation:      Portrait

docs/index.md

@@ -13,7 +13,11 @@ VERBOSE: Out-WinPrint 2.0.3.0 - Copyright Kindel Systems, LLC - https://tig.gith
 ```
 
 ```powershell
-get-content Program.cs | wp
+out-winprint Program.cs
+```
+
+```powershell
+cat $profile.CurrentUserAllHosts | wp -Language powershell
 ```
 
 ```powershell
@@ -22,7 +26,7 @@ ls .\* -include ('*.c', '*.h') | foreach { cat $_.FullName | out-winprint -p "La
 
 ## Features
 
-* Print source code with syntax highlighting and line numbering for over 200 programming langauges and file formats.
+* Print source code with syntax highlighting and line numbering for over 200 programming languages and file formats.
 * Print HTML files.
 * Print "multiple-pages-up" on one piece of paper (saves trees!)
 * Complete control over page formatting options, including headers and footers, margins, fonts, page orientation, etc...
@@ -41,7 +45,17 @@ See [User's Guide](users-guide.md) for more details.
 
 See [About](about.md) for the history prior to *winprint 2.0*.
 
-* 12-Apr-2020 - 2.0.0.6100 (Beta1) - Updated PowerShell cmdlet to run as a standalone app (e.g. wp foo.cs or out-winprint foo.cs.
+* 30-Apr-2020 - 2.0.4 (RC1) - Totally new rendering engine
+  * Replaced the nodejs `Prism.js`-based syntax highlighter with the Python `Pigyments`-based system. This:
+    * Long lines now wrap correctly. Issue #12
+    * Significantly increased file load/rendering speed. Issue #13.
+    * Space and tabs now render accurately. Issue #14
+    * Improved syntax highlighting in almost every way. More reliable, better language support, more sophisticated lexers.
+    * Provided a simple way to select styles (e.g. `"style": "pastie"` in `.config` file).
+    * Enabled printing of ANSI Escape sequence encoded files (because `winprint` uses Pygments `terminal` formatter as input).
+    * Removed dependency on nodejs. Issue #17
+  * Dozens of small bug fixes and improvements.
+* 12-Apr-2020 - 2.0.0.6100 (Beta3) - Updated PowerShell cmdlet to run as a standalone app (e.g. wp foo.cs or out-winprint foo.cs.
   * Added ability to choose fonts from GUI
   * fixed print preview status bugs
   * Code refactoring; because why leave good enough alone?

docs/install.md

@@ -1,6 +1,6 @@
 # Installation Instructions
 
-***winprint*** 2.0 is in beta. It works well (on my machine), and I've had a dozen or so users verify it works well for them; see [Issues](https://github.com/tig/winprint/issues).*
+***winprint*** 2.0 is almost not beta. It works well (on my machine), and I've had a dozen or so users verify it works well for them; see [Issues](https://github.com/tig/winprint/issues).*
 
 *Please report any problems or feature requests [here](https://github.com/tig/winprint/issues).*
 

docs/users-guide.md

@@ -2,7 +2,7 @@
 
 ## Features
 
-* Print source code with syntax highlighting and line numbering for over 200 programming langauges and file formats.
+* Print source code with syntax highlighting and line numbering for over 200 programming languages and file formats.
 * Print HTML files.
 * Print "multiple-pages-up" on one piece of paper (saves trees!)
 * Complete control over page formatting options, including headers and footers, margins, fonts, page orientation, etc...
@@ -39,7 +39,7 @@ See what version is installed:
 
 ```powershell
 PS > out-winprint -verbose
-VERBOSE: Out-WinPrint 2.0.0.3912 - Copyright Kindel Systems, LLC - https://tig.github.io/winprint
+VERBOSE: Out-WinPrint 2.0.4.1 - Copyright Kindel Systems, LLC - https://tig.github.io/winprint
 PS >
 ```
 
@@ -55,6 +55,10 @@ Or, more tersely:
 cat program.cs | wp
 ```
 
+```powershell
+cat $profile.CurrentUserAllHosts | wp -Language powershell
+```
+
 Or, using more features:
 
 ```powershell
@@ -387,13 +391,15 @@ The **winprint** GUI can be used to change many Sheet Definition settings. All s
 
 **winprint** supports three types of files. Support for each is provided by a **winprint** Content Type Engine (CTE):
 
-1. **`text/plain`** - This CTE knows only how to print raw `text/plain` files. The format of the printed text can be changed (e.g. to turn off line numbers or use a differnt font). Lines that are too long for a page are wrapped at character boundaries. `\r` (formfeed) characters can be made to cause following text to print on the next page (this is off by default). Settings for the `text/plain` can be changed by editing the `textFileSettings` section of a Sheet Definition in the `WinPrint.config.json` file.
+1. **`AnsiCte`** - This is the default CTE used for most file types. `AnsiCte` can format `text/plain` files as well as files with embedded `ANSI Escape Sequences`.  `AnsiCte` provides **winprint**'s syntax highlighting (pretty printing) with support for over 200 programming languages. Over a dozen styles (colors, bold, italic, etc...) are supported (change the `style` entry in the `WinPrint.config.json` file). All styles supported by [Pygments](https://pygments.org/) are supported.
+
+2. **`TextCte`** - This CTE knows only how to print raw `text/plain` files. The format of the printed text can be changed (e.g. to turn off line numbers or use a different font). Lines that are too long for a page are wrapped at character boundaries. `\r` (formfeed) characters can be made to cause following text to print on the next page (this is off by default). Settings for the `text/plain` can be changed by editing the `textFileSettings` section of a Sheet Definition in the `WinPrint.config.json` file. `TextCte` is not enabled by default and may be removed from future versions as `AnsiCte` does almost everything `TextCte` does (with the exeption of form-feeds).
 
-2. **`text/html`** - This CTE can render html files. Any CSS specified inline in the HTML file will be honored. External CSS files must be local. For HTML without CSS, the default CSS used can be overridden by providing a file named `winprint.css` in the `%appdata%\Kindel Systems\winprint` folder. `text/html` does not support line numbers.
+3. **`text/html`** - This CTE can render html files. Any CSS specified inline in the HTML file will be honored. External CSS files must be local. For HTML without CSS, the default CSS used can be overridden by providing a file named `winprint.css` in the `%appdata%\Kindel Systems\winprint` folder. `text/html` does not support line numbers.
 
-3. **`text/code`** - The text/code CTE supports syntax highlighting (pretty printing), with optional line numbering, of over 200 programming languages. The style of the printing can be changed by providing a file named `winprint-prism.css` in the `%appdata%\Kindel Systems\winprint` folder. The styles defined in this format should match those defined for [PrismJS](https://prismjs.com). Any PrismJS style sheet will work with **winprint**. For example, to use the Coy theme copy `prism-coy.css` into the `%appdata%\Kindel Systems\winprint` and rename it `prism-winprint.css`.
+When using **winprint** from the command line, the `-ContentTypeEngine` parameter can be used specify a CTE to use.
 
-The extension of the file being printed (e.g. `.cs`) determines which Content Type rendering engine will be used. **winprint** has a built-in library of hundreds of file extension to content type/language mappings.
+The extension of the file being printed (e.g. `.cs`) determines which Content Type rendering engine will be used. **winprint** has a built-in library of hundreds of file extension to content type/language mappings. When using **winprint** from the command line, the `-Langauge` parameter can be used to override this behavior.
 
 To associate a file extension with a particular Content Type Engine modify the `files.associations` section of `WinPrint.config.json` appropriately. For example to associate files with a `.htm` extension with the `text/html` Content Type Engine add a line as shown below (the `WinPrint.config.json` generated when **winprint** runs the first time already provides this example, as an example):
 
@@ -421,8 +427,6 @@ To associate a file extension with a language supported by `text/code` modify th
     }
 ```
 
-To determine the name to use (e.g. `json`) see the [PrismJS](https://prismjs.com/#supported-languages) list of languages.
-
 A new language can be defined by aliasing it to an existing language by modifying the `languages` section of `WinPrint.config.json`.
 
 For example to enable the [Icon Programming Language](https://en.wikipedia.org/wiki/Icon_%28programming_language%29) which is a very C-like language the `files.associations` and `languages` sections would look like the following:

src/WinPrint.Console/OutWinPrint.cs

@@ -12,6 +12,7 @@
 using System.Management.Automation.Internal;
 using System.Management.Automation.Runspaces;
 using System.Reflection;
+using System.Text;
 using System.Text.Json;
 using System.Threading;
 using System.Threading.Tasks;
@@ -532,6 +533,7 @@ await Task.Run(() => ServiceLocator.Current.UpdateService.GetLatestVersionAsync(
                     // See: https://stackoverflow.com/questions/60712580/invoking-cmdlet-from-a-c-based-pscmdlet-providing-input-and-capturing-output
                     var textToPrint = SessionState.InvokeCommand.InvokeScript(@"$input | Out-String", true, PipelineResultTypes.None, _psObjects, null)[0].ToString();
 
+                    _print.SheetViewModel.Encoding = Encoding.UTF8;
                     await _print.SheetViewModel.LoadStringAsync(textToPrint, (string)contentTypeEngine).ConfigureAwait(true);
                 }
             }
@@ -799,13 +801,13 @@ public object GetDynamicParameters() {
             }));
 
             // -Language
-            runtimeDict.Add("Language", new RuntimeDefinedParameter("Language", typeof(String), new Collection<Attribute>() {
-                    new ParameterAttribute() {
-                        HelpMessage = "Optional language to use for syntax highlighting.",
-                        ParameterSetName = "Print"
-                    },
-                    new ValidateSetAttribute(ModelLocator.Current.Associations.Languages.Select(l => l.Id).ToArray())
-            }));
+            //runtimeDict.Add("Language", new RuntimeDefinedParameter("Language", typeof(String), new Collection<Attribute>() {
+            //        new ParameterAttribute() {
+            //            HelpMessage = "Optional language to use for syntax highlighting.",
+            //            ParameterSetName = "Print"
+            //        },
+            //        new ValidateSetAttribute(ModelLocator.Current.Associations.Languages.Select(l => l.Id).ToArray())
+            //}));
 
             return runtimeDict;
         }

src/WinPrint.Console/WinPrint.Console.csproj

@@ -9,7 +9,7 @@
     <AssemblyName>winprint</AssemblyName>
     <StartupObject></StartupObject>
 
-    <Version>2.0.3.95</Version>
+    <Version>2.0.4.100</Version>
     <Company>Kindel Systems</Company>
     <Product>winprint</Product>
     <Authors>Charlie Kindel</Authors>
@@ -60,4 +60,8 @@
     </EmbeddedResource>
   </ItemGroup>
 
+  <Target Name="PostBuild" AfterTargets="PostBuildEvent">
+    <Exec Command="copy $(SolutionDir)..\tools\pygmentize.exe $(TargetDir)" />
+  </Target>
+
 </Project>

src/WinPrint.Core/ContentTypeEngines/HtmlCte.cs

@@ -80,7 +80,7 @@ public override async Task<int> RenderAsync(System.Drawing.Printing.PrinterResol
 
             string css;
             try {
-                // TODO: Make sure wiprint.css is in the same dir as .config file once setup is impl
+                // TODO: Make sure winprint.css is in the same dir as .config file once setup is impl
                 using var cssStream = new StreamReader("winprint.css");
                 css = await cssStream.ReadToEndAsync();
                 cssStream.Close();

src/WinPrint.Core/Models/Settings.cs

@@ -223,7 +223,7 @@ public static Settings CreateDefaultSettings() {
             var defaultHFFontSize = 10F;
             var defaultHFFontStyle = FontStyle.Bold;
 
-            var defaultHeaderText = "{DateRevised:D}|{FileName}|Type: {FileType}";
+            var defaultHeaderText = "{DateRevised:D}|{FileName}|Type: {Language}";
             var defualtFooterText = "Printed with love by WinPrint||Page {Page} of {NumPages}";
 
             var settings = new Settings {

src/WinPrint.Core/Resources/FileTypeMapping.json

@@ -1689,7 +1689,8 @@
       "extensions": [
         ".mak",
         ".d",
-        ".mk"
+        ".mk",
+        ".am"
       ]
     },
     {

src/WinPrint.Core/Services/PygmentsConverterService.cs

@@ -3,6 +3,7 @@
 using System.Diagnostics;
 using System.IO;
 using System.Linq;
+using System.Reflection;
 using System.Text;
 using System.Threading.Tasks;
 using IronPython.Hosting;
@@ -37,7 +38,7 @@ public async Task<string> ConvertAsync(string document, string style, string lan
 
             string file = Path.GetTempFileName();
             _proc = new Process();
-            _proc.StartInfo.FileName = @"pygmentize.exe";
+            _proc.StartInfo.FileName = @$"{Path.GetDirectoryName(Assembly.GetAssembly(typeof(PygmentsConverterService)).Location)}\pygmentize.exe";
             _proc.StartInfo.Arguments = $"-P outencoding=utf-8 -f 16m -O style={(string.IsNullOrEmpty(style) ? "default" : style)} -l {language} -o {file}.an {file}";
             _proc.StartInfo.RedirectStandardInput = true;
             _proc.StartInfo.RedirectStandardOutput = true;
@@ -54,24 +55,21 @@ public async Task<string> ConvertAsync(string document, string style, string lan
                 await File.WriteAllTextAsync(file, document, Encoding.UTF8).ConfigureAwait(true);
                 Log.Debug("Starting {pyg} {args}", _proc.StartInfo.FileName, _proc.StartInfo.Arguments);
                 _proc.Start();
-            }
-            catch (Exception e) {
-                // TODO: Better error message (output of stderr?)
-                Log.Information("Failed to pygmentize: {Message}", e.Message);
-                document = $"{ _proc.StartInfo.FileName} { _proc.StartInfo.Arguments} failed:\n{e.Message}:\n";
-            }
-            finally {
+
                 Log.Debug("Waiting for pygments to exit");
                 await Task.WhenAny(_eventHandled.Task, Task.Delay(10000)).ConfigureAwait(true);
 
                 if (_proc.ExitCode != 0) {
                     var stdErr = _proc.StandardError.ReadToEnd();
-                    Log.Information("Failed to pygmentize: {Message}", stdErr);
+                    if (stdErr.StartsWith("Usage:")) {
+                        stdErr = "Invalid command line.";
+                    }
+                    document = $"Pygments encountered an error: {stdErr}";
+                    Log.Information("{document}", document);
                     // TODO: This should really throw an exception
-                    document = $"Failed to pygmentize: {stdErr}";
+                    throw new InvalidOperationException(document);
                 }
                 else {
-
                     if (!string.IsNullOrEmpty($"{file}.an") && File.Exists($"{file}.an")) {
                         Log.Debug("Reading {file}", $"{file}.an");
                         document = await File.ReadAllTextAsync($"{file}.an", Encoding.UTF8).ConfigureAwait(true);
@@ -80,8 +78,22 @@ public async Task<string> ConvertAsync(string document, string style, string lan
                         if (document[^1] == '\n')
                             document = document.Remove(document.Length - 1, 1);
                     }
+                    else {
+                        // TODO: This should really throw an exception
+                        var stdErr = _proc.StandardError.ReadToEnd();
+                        document = $"Pygments failed to create converter file: {stdErr}";
+                        Log.Information("{document}", document);
+                        throw new InvalidOperationException(document);
+                    }
                 }
-
+            }
+            catch (System.ComponentModel.Win32Exception e) {
+                // TODO: Better error message (output of stderr?)
+                document = $"Could not format document:\n{ _proc.StartInfo.FileName} { _proc.StartInfo.Arguments} failed:\n{e.Message}";
+                Log.Error(e, "{document}", document);
+                throw new InvalidOperationException(document);
+            }
+            finally {
                 // Clean up
                 if (!string.IsNullOrEmpty(file) && File.Exists(file)) {
                     File.Delete(file);