/*
 * *****************************************************************************
 * Copyright (C) National University of Quilmes 2018-2024
 * Gobstones (TM) is a trademark of the National University of Quilmes.
 *
 * This program is free software distributed under the terms of the
 * GNU Affero General Public License version 3.
 * Additional terms added in compliance to section 7 of such license apply.
 *
 * You may read the full license at https://gobstones.github.io/gobstones-guidelines/LICENSE.
 * *****************************************************************************
 */

/**
 * @module SourceReader/SourcePositions
 * @author Alan Rodas Bonjour <alanrodas@gmail.com>
 */

import { DocumentSourcePosition } from './DocumentSourcePosition';
import { EndOfDocumentSourcePosition } from './EndOfDocumentSourcePosition';
import { EndOfInputSourcePosition } from './EndOfInputSourcePosition';
import { UnknownSourcePosition } from './UnknownSourcePosition';

import { SourceReader } from '../SourceReader';

/**
 * The constant implementing the
 * [Abstract Factory Pattern](https://en.wikipedia.org/wiki/Abstract_factory_pattern)
 * for {@link SourceReader.SourcePosition}s.
 */
export const SourcePositionFactory = {
    Unknown: () => UnknownSourcePosition.instance,
    EndOfInput: (_sr: SourceReader) => new EndOfInputSourcePosition(_sr),
    EndOfDocument: (
        _sr: SourceReader,
        line: number,
        column: number,
        regions: string[],
        _documentIdx: number,
        _charIdx: number,
        _visibleCharsIdx: number
    ) => new EndOfDocumentSourcePosition(_sr, line, column, regions, _documentIdx, _charIdx, _visibleCharsIdx),
    Document: (
        _sr: SourceReader,
        line: number,
        column: number,
        regions: string[],
        _documentIdx: number,
        _charIdx: number,
        _visibleCharsIdx: number
    ) => new DocumentSourcePosition(_sr, line, column, regions, _documentIdx, _charIdx, _visibleCharsIdx)
};