net.sf.saxon.regex.OpBOL Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of Saxon-HE Show documentation

The XSLT and XQuery Processor

There is a newer version: 12.5

////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2018-2023 Saxonica Limited
// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// This Source Code Form is "Incompatible With Secondary Licenses", as defined by the Mozilla Public License, v. 2.0.
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////

package net.sf.saxon.regex;

import net.sf.saxon.expr.sort.EmptyIntIterator;
import net.sf.saxon.z.IntIterator;
import net.sf.saxon.z.IntSingletonIterator;

/**
 * Beginning of Line (^) in a regular expression
 */

public class OpBOL extends Operation {

    @Override
    public int getMatchLength() {
        return 0;
    }

    @Override
    public int matchesEmptyString() {
        return MATCHES_ZLS_AT_START;
    }

    @Override
    public IntIterator iterateMatches(final REMatcher matcher, final int position) {
        // Fail if we're not at the start of the string
        if (position != 0) {
            // If we're multiline matching, we could still be at the start of a line
            if (matcher.program.flags.isMultiLine()) {
                // Continue if at the start of a line
                if (matcher.isNewline(position - 1) && !(position >= matcher.search.length())) {
                    return new IntSingletonIterator(position);
                }
            }
            return EmptyIntIterator.getInstance();
        }
        return new IntSingletonIterator(position);
    }

    /**
     * Display the operation as a regular expression, possibly in abbreviated form
     *
     * @return the operation in a form that is recognizable as a regular expression or abbreviated
     * regular expression
     */
    @Override
    public String display() {
        return "^";
    }
}