Method FormatRange

scintilla/src/Editor.cxx:3834–4006

This is mostly copied from the Paint method but with some things omitted such as the margin markers, line numbers, selection and caret Should be merged back into a combined Draw method.

// such as the margin markers, line numbers, selection and caret
// Should be merged back into a combined Draw method.
long Editor::FormatRange ( bool draw, Sci_RangeToFormat *pfr )
{
    if ( !pfr ) {
        return 0;
    }
    AutoSurface surface ( pfr->hdc, this, SC_TECHNOLOGY_DEFAULT );
    if ( !surface ) {
        return 0;
    }
    AutoSurface surfaceMeasure ( pfr->hdcTarget, this, SC_TECHNOLOGY_DEFAULT );
    if ( !surfaceMeasure ) {
        return 0;
    }
    // Can't use measurements cached for screen
    posCache.Clear();
    ViewStyle vsPrint ( vs );
    vsPrint.technology = SC_TECHNOLOGY_DEFAULT;
    // Modify the view style for printing as do not normally want any of the transient features to be printed
    // Printing supports only the line number margin.
    int lineNumberIndex = -1;
    for ( int margin = 0; margin <= SC_MAX_MARGIN; margin++ ) {
        if ( ( vsPrint.ms[margin].style == SC_MARGIN_NUMBER ) && ( vsPrint.ms[margin].width > 0 ) ) {
            lineNumberIndex = margin;
        } else {
            vsPrint.ms[margin].width = 0;
        }
    }
    vsPrint.fixedColumnWidth = 0;
    vsPrint.zoomLevel = printMagnification;
    // Don't show indentation guides
    // If this ever gets changed, cached pixmap would need to be recreated if technology != SC_TECHNOLOGY_DEFAULT
    vsPrint.viewIndentationGuides = ivNone;
    // Don't show the selection when printing
    vsPrint.selbackset = false;
    vsPrint.selforeset = false;
    vsPrint.selAlpha = SC_ALPHA_NOALPHA;
    vsPrint.selAdditionalAlpha = SC_ALPHA_NOALPHA;
    vsPrint.whitespaceBackgroundSet = false;
    vsPrint.whitespaceForegroundSet = false;
    vsPrint.showCaretLineBackground = false;
    vsPrint.alwaysShowCaretLineBackground = false;
    // Don't highlight matching braces using indicators
    vsPrint.braceHighlightIndicatorSet = false;
    vsPrint.braceBadLightIndicatorSet = false;
    // Set colours for printing according to users settings
    for ( size_t sty = 0; sty < vsPrint.styles.size(); sty++ ) {
        if ( printColourMode == SC_PRINT_INVERTLIGHT ) {
            vsPrint.styles[sty].fore = InvertedLight ( vsPrint.styles[sty].fore );
            vsPrint.styles[sty].back = InvertedLight ( vsPrint.styles[sty].back );
        } else if ( printColourMode == SC_PRINT_BLACKONWHITE ) {
            vsPrint.styles[sty].fore = ColourDesired ( 0, 0, 0 );
            vsPrint.styles[sty].back = ColourDesired ( 0xff, 0xff, 0xff );
        } else if ( printColourMode == SC_PRINT_COLOURONWHITE ) {
            vsPrint.styles[sty].back = ColourDesired ( 0xff, 0xff, 0xff );
        } else if ( printColourMode == SC_PRINT_COLOURONWHITEDEFAULTBG ) {
            if ( sty <= STYLE_DEFAULT ) {
                vsPrint.styles[sty].back = ColourDesired ( 0xff, 0xff, 0xff );
            }