Source/WebInspectorUI/UserInterface/Models/SourceCodeTextRange.js

/*
 * Copyright (C) 2013 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

WI.SourceCodeTextRange = class SourceCodeTextRange extends WI.Object
{
    constructor(sourceCode) /* textRange || startLocation, endLocation */
    {
        super();

        console.assert(sourceCode instanceof WI.SourceCode);
        console.assert(arguments.length === 2 || arguments.length === 3);

        this._sourceCode = sourceCode;

        if (arguments.length === 2) {
            var textRange = arguments[1];
            console.assert(textRange instanceof WI.TextRange);
            this._startLocation = sourceCode.createSourceCodeLocation(textRange.startLine, textRange.startColumn);
            this._endLocation = sourceCode.createSourceCodeLocation(textRange.endLine, textRange.endColumn);
        } else {
            console.assert(arguments[1] instanceof WI.SourceCodeLocation);
            console.assert(arguments[2] instanceof WI.SourceCodeLocation);
            this._startLocation = arguments[1];
            this._endLocation = arguments[2];
        }

        this._startLocation.addEventListener(WI.SourceCodeLocation.Event.LocationChanged, this._sourceCodeLocationChanged, this);
        this._endLocation.addEventListener(WI.SourceCodeLocation.Event.LocationChanged, this._sourceCodeLocationChanged, this);
    }

    // Public

    get sourceCode()
    {
        return this._sourceCode;
    }

    // Raw text range in the original source code.

    get textRange()
    {
        var startLine = this._startLocation.lineNumber;
        var startColumn = this._startLocation.columnNumber;
        var endLine = this._endLocation.lineNumber;
        var endColumn = this._endLocation.columnNumber;
        return new WI.TextRange(startLine, startColumn, endLine, endColumn);
    }

    // Formatted text range in the original source code if it is pretty printed.
    // This is the same as the raw text range if the source code has no formatter.

    get formattedTextRange()
    {
        var startLine = this._startLocation.formattedLineNumber;
        var startColumn = this._startLocation.formattedColumnNumber;
        var endLine = this._endLocation.formattedLineNumber;
        var endColumn = this._endLocation.formattedColumnNumber;
        return new WI.TextRange(startLine, startColumn, endLine, endColumn);
    }

    // Display values:
    //   - Mapped resource and text range locations if the original source code has a
    //     source map and both start and end locations are in the same mapped resource.
    //   - Otherwise this is the formatted / raw text range.

    get displaySourceCode()
    {
        if (!this._startAndEndLocationsInSameMappedResource())
            return this._sourceCode;

        return this._startLocation.displaySourceCode;
    }

    get displayTextRange()
    {
        if (!this._startAndEndLocationsInSameMappedResource())
            return this.formattedTextRange;

        var startLine = this._startLocation.displayLineNumber;
        var startColumn = this._startLocation.displayColumnNumber;
        var endLine = this._endLocation.displayLineNumber;
        var endColumn = this._endLocation.displayColumnNumber;
        return new WI.TextRange(startLine, startColumn, endLine, endColumn);
    }

    get synthesizedTextValue()
    {
        // Must add 1 to the lineNumber since it starts counting at 0.
        return this._sourceCode.url + ":" + (this._startLocation.lineNumber + 1);
    }

    // Private

    _startAndEndLocationsInSameMappedResource()
    {
        return this._startLocation.hasMappedLocation() && this._endLocation.hasMappedLocation() && this._startLocation.displaySourceCode === this._endLocation.displaySourceCode;
    }

    _sourceCodeLocationChanged(event)
    {
        this.dispatchEventToListeners(WI.SourceCodeLocation.Event.RangeChanged);
    }
};

WI.SourceCodeTextRange.Event = {
    RangeChanged: "source-code-text-range-range-changed"
};