capslocky November 5, 2014 at 11:14

How to keep the original coloring of your code from Visual Studio in a publication on Habrahabr. Compare colors. Poll

Hi, Habrauser! In this post I will tell you how you can make your Habré code more “alive” thanks to a simple way to save its original color scheme. And also I propose to compare different options for coloring the code.

Foreword

Now I am in the process of writing my first article for Habr about web services. And from the very beginning I decided that I would highlight the source codes with a third-party habr-highlighter, since the standard tagin my opinion does not give a qualitative syntax highlighting effect. However, I found only one alternative highlighter - http://highlight.hohli.com . The result of its coloring, unfortunately, did not inspire me. At the end of the post, I show it among 6 color options for direct comparison. Once before there was another highlighter - Source Code Highlighter , described on Habré here and here , but it has not been working for a long time . Then I remembered that the code from Visual Studio completely retains its appearance when copying to Word, this simple technique became the basis of my method.

Method

The idea is simple: the code is copied to Word, the document is saved as an html web page and the function converts the html code to a Habra-compatible one. Let's look at an example. This simple code when saved gives the following contentswhere in blue I marked all the tags , pink is the color of the style, and brown is the displayed text itself.

private void Hello () {
MessageBox.Show ("Hello Habrahabr!");
}

Hello.htm

normal; mso-layout-grid-align: none; text-autospace: none '> style =' font-size: 9.5pt; font-family: Consolas; color: black; background: white;
mso-highlight: white; mso-ansi-language: EN-US '> style = 'mso-spacerun: yes'>        lang = EN-US style = 'font-size: 9.5pt; font-family: Consolas; color: blue; background:
white; mso-highlight: white; mso-ansi-language: EN-US'> private lang = EN-US style = 'font-size: 9.5pt; font-family: Consolas; color: black; background:
white; mso-highlight: white; mso-ansi-language: EN-US'> style = 'font -size: 9.5pt; font-family: Consolas; color: blue; background: white;
mso-highlight: white; mso-ansi-language: EN-US '> void style =' font-size: 9.5pt; font-family: Consolas; color: black; background: white;
mso-highlight: white; mso-ansi-language: EN-US '> Hello () {

normal; mso-layout-grid-align: none; text-autospace: none '> style =' font-size: 9.5pt; font-family: Consolas; color: black; background: white;
mso-highlight: white; mso-ansi-language: EN-US '> style = 'mso-spacerun: yes'>            lang = EN-US style = 'font-size: 9.5pt; font-family: Consolas; color: # 2B91AF;
background: white; mso-highlight: white; mso-ansi-language: EN-US '> MessageBox lang = EN-US style = 'font-size: 9.5pt; font-family: Consolas; color: black; background:
white; mso-highlight: white; mso-ansi-language: EN-US'> .Show ( lang = EN-US style = 'font-size: 9.5pt; font-family: Consolas; color: # A31515;
background: white; mso-highlight: white; mso-ansi-language: EN-US '> "Hello
Habrahabr ! & quot ; );

        style = 'font-size: 9.5pt; line-height: 115%; font-family: Consolas; color: black;
background: white; mso-highlight: white '> }

As you can see, each line of source code is converted to a tag

, inside of which text is formatted using nested tags , and its color is stored in the style attribute . The conversion algorithm becomes clear: for each tag

from "/ html / body / div / p" recursively translate its contents into a new html document, along with the tagsetting the color of the text. Under the spoiler is the full source code of the resulting method, which looks in accordance with my original color scheme. To work with html, the Html Agility Pack library was used .

HabraCodeFormatter.cs

using System;
using System.IO;
using HtmlAgilityPack;

namespace HabraCode {
    public static class HabraCodeFormatter {
        const char spaceClassic = (char) 32 ;
        const char spaceNbsp = (char) 160 ;

        public static void Format (string fileHtm, bool withLineNumbers = false) {
            var info = new FileInfo (fileHtm);
            string destFile = info.DirectoryName + "\\" + info.Name.Replace (info.Extension, null) + "_result.txt";
            Format (fileHtm, destFile, withLineNumbers);
        }

        public static void Format (string fileHtm, string fileDest, bool withLineNumbers = false) {
            var doc = new HtmlDocument ();
            doc.Load (fileHtm);
            var nodes = doc.DocumentNode.SelectNodes ("/ html / body / div / p");
            int spacesToDelete = getSpacesToDelete (nodes [ 0 ]);

            var result = new HtmlDocument ();
            var rootNode = result.CreateElement ("blockquote");
            result.DocumentNode.AppendChild (rootNode);

            if (withLineNumbers) {
                var nodeOl = result.CreateElement ("ol");
                rootNode.AppendChild (nodeOl);
                rootNode = nodeOl;
            }

            foreach (var node in nodes) {
                if (withLineNumbers) {
                    var nodeLi = doc.CreateElement ("li");
                    nodeLi.AppendChildren (node.ChildNodes);
                    node.RemoveAllChildren ();
                    node.AppendChild (nodeLi);
                }

                int refSpaces = spacesToDelete;
                translateNode (node, rootNode, ref refSpaces);
                rootNode.AppendChild (result.CreateTextNode (Environment.NewLine));
            }

            result.Save (fileDest);
        }

        private static int getSpacesToDelete (HtmlNode node) {
            for (int index = 0 ; index <node.InnerText.Length; index ++) {
                if (! isSpace (node.InnerText [index])) {
                    return index;
                }
            }

            return 0 ;
        }

        private static void translateNode (HtmlNode node, HtmlNode destParent, ref int spacesToDelete) {
            HtmlNode destNode = destParent;

            switch (node.Name) {
                case "o: p":
                case "p":
                    break;

                case "span":
                    string color = getColor (node);

                    if (color! = null) {
                        destNode = destParent.OwnerDocument.CreateElement ("font");
                        destNode.SetAttributeValue ("color", color);
                    }
                    break;

                case "#text":
                    string text = translateText (node.InnerText, ref spacesToDelete);
                    destNode = destParent.OwnerDocument.CreateTextNode (text);
                    break;

                case "b":
                case "li":
                    destNode = destParent.OwnerDocument.CreateElement (node.Name);
                    break;

                default:
                    throw new InvalidOperationException ("Unexpected node.Name" + node.Name);
            }

            if (! ReferenceEquals (destNode, destParent)) {
                destParent.ChildNodes.Add (destNode);
            }

            if (node.HasChildNodes) {
                foreach (HtmlNode child in node.ChildNodes) {
                    translateNode (child, destNode, ref spacesToDelete);
                }
            }
        }

        private static string translateText (string text, ref int spaces) {
            if (string.IsNullOrEmpty (text)) {
                return text;
            }

            text = text.Replace ("http: //", "http: //");
            text = text.Replace ("\ r \ n", "");

            if (spaces> 0 && text.Length> = spaces && isSpace (text.Substring ( 0 , spaces))) {
                text = text.Remove ( 0 , spaces);
                spaces = 0 ;
            }

            text = text.Replace ( spaceClassic .ToString (), "");
            text = text.Replace ( spaceNbsp .ToString (), "");
            return text;
        }

        private static bool isSpace (char ch) {
            return (ch == spaceClassic || ch == spaceNbsp );
        }

        private static bool isSpace (string text) {
            foreach (char ch in text) {
                if (! isSpace (ch)) {
                    return false;
                }
            }

            return true;
        }

        private static string getColor (HtmlNode node) {
            var attr = node.Attributes ["style"];

            if (attr == null || attr.Value == null) {
                return null;
            }

            string [] values = attr.Value.Split (new [] {';'});

            foreach (string value in values) {
                const string prefixColor = "color:";
                string trimmed = value.Trim ();

                if (trimmed.StartsWith ( prefixColor )) {
                    return trimmed.Remove ( 0 , prefixColor .Length);
                }
            }

            return null;
        }
    }
}

Most likely, many will call my color code too colorful, and therefore uncomfortable, but it significantly improves my process of working with source code. This is a very simple way to improve your performance a bit. A little comment on the code. The class contains two overloads of the Format method, where the required parameter is the path to the source html file, and the optional flag for adding line numbers. The second overload allows you to explicitly specify the final file, otherwise the result will be saved as [source_name] _result.txt. The getSpacesToDelete method allows you to find the number of leading spaces in the first line to remove them in all subsequent lines.

The font and coloring of the source code in Visual Studio is configured in the menu Tools> Options> Environment> Fonts and Colors. However, initially it does not have the ability to set its color for a method or property. But if you use ReSharper, such an opportunity appears. To do this, in the menu ReSharper> Options> Code Inspection> Settings , enable the item Color identifires . And here you can experience a slight cognitive dissonance, because the methods will become turquoise - the classes have this color in the traditional scheme, and the classes will become dark blue - all this can be seen below, where I compare the colors.

In my scheme, classes, keywords, and other elements have a classic color, but they add their own colors for methods and properties. For those who want to try it, I bring the setting. Save the xml under the spoiler as a file with the .vssettings extension in UTF-8 encoding without a BOM, for example, HabraCode.vssettings, and import the settings through the menu Tools> Import and Export Settings> Import ... The encoding can be set, for example, using Notepad ++ . By default, the wizard also saves all your current settings along the way - so that changes can be rolled back. After import, the font will be reset to default, and if you had a custom one, you will need to specify it again. Also, in the “Plain Text” setting, I slightly reduced the whiteness of the background, reducing it from absolute to #FAFAFA.

HabraCode.vssettings

Comparison

Now I propose to compare 6 options for coloring the code on the example of one of the methods. It cannot be argued that some kind of color is, in principle, the best, because, as you know, there are no comrades for the taste and color. But I am interested in the collective opinion of the habr community.

1.

private static string getColor(HtmlNode node){
    var attr = node.Attributes["style"];
    if (attr == null || attr.Value == null){
        return null;
    }
    string[] values = attr.Value.Split(new [] {';'});
    foreach (string value in values){
        const string prefixColor = "color:";
        string trimmed = value.Trim();
        if (trimmed.StartsWith(prefixColor)){
            return trimmed.Remove(0, prefixColor.Length);
        }
    }
    return null;
}

2. Black-and-white code (obtained through HabraCodeFormatter with rejection of color and bold)

private static string getColor (HtmlNode node) {
    var attr = node.Attributes ["style"];

    if (attr == null || attr.Value == null) {
        return null;
    }

    string [] values = attr.Value.Split (new [] {';'});

    foreach (string value in values) {
        const string prefixColor = "color:";
        string trimmed = value.Trim ();

        if (trimmed.StartsWith (prefixColor)) {
            return trimmed.Remove (0, prefixColor.Length);
        }
    }

    return null;
}

3.http: //highlight.hohli.com

private static string getColor (HtmlNode node) {
    var attr = node.Attributes ["style"];

    if (attr == null || attr.Value == null) {
        return null;
    }

    string [] values = attr.Value.Split (new [] {';'});

    foreach (string value in values) {
        const string prefixColor = "color:";
        string trimmed = value.Trim ();

        if (trimmed.StartsWith (prefixColor)) {
            return trimmed.Remove (0, prefixColor.Length);
        }
    }

    return null;
}

4. Standard coloring of Visual Studio

private static string getColor (HtmlNode node) {
    var attr = node.Attributes ["style"];

    if (attr == null || attr.Value == null) {
        return null;
    }

    string [] values = attr.Value.Split (new [] {';'});

    foreach (string value in values) {
        const string prefixColor = "color:";
        string trimmed = value.Trim ();

        if (trimmed.StartsWith (prefixColor)) {
            return trimmed.Remove (0, prefixColor.Length);
        }
    }

    return null;
}

5. Standard color reshaper

private static string getColor (HtmlNode node) {
    var attr = node.Attributes ["style"];

    if (attr == null || attr.Value == null) {
        return null;
    }

    string [] values = attr.Value.Split (new [] {';'});

    foreach (string value in values) {
        const string prefixColor = "color:";
        string trimmed = value .Trim ();

        if (trimmed.StartsWith ( prefixColor )) {
            return trimmed.Remove (0, prefixColor .Length);
        }
    }

    return null;
}

6. Author's coloring

private static string getColor (HtmlNode node) {
    var attr = node.Attributes ["style"];

    if (attr == null || attr.Value == null) {
        return null;
    }

    string [] values = attr.Value.Split (new [] {';'});

    foreach (string value in values) {
        const string prefixColor = "color:";
        string trimmed = value.Trim ();

        if (trimmed.StartsWith ( prefixColor )) {
            return trimmed.Remove ( 0 , prefixColor .Length);
        }
    }

    return null;
}

Only registered users can participate in the survey. Please come in.

And now the survey. Which of these color code options will suit you in publications on Habrahabr?

37.6% source lang = "cs" 94
6.4% Black and White Code 16
6% http://highlight.hohli.com 15
40.4% Standard Color Visual Studio 101
30.8% Standard color Reshaper 77
24.4% Color 61

Tags:

How to keep the original coloring of your code from Visual Studio in a publication on Habrahabr. Compare colors. Poll

Foreword

Method

Comparison

And now the survey. Which of these color code options will suit you in publications on Habrahabr?

Also popular now: