﻿#region License
/* Copyright (c) 2017-2018 Wes Hampson
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */
#endregion

using System.Collections.Generic;
using WHampson.Cascara.Extensions;

namespace WHampson.Cascara.Interpreter
{
    internal static partial class ReservedWords
    {
        /// <summary>
        /// Defines all special variable identifiers.
        /// </summary>
        /// <remarks>
        /// "Special variables" are variables that are predefined by the interpreter.
        /// </remarks>
        public static class SpecialVariables
        {
            public const string Offset = "__OFFSET__";
            public const string GlobalOffset = "__GLOBALOFFSET__";
            public const string Filesize = "__FILESIZE__";

            public static readonly HashSet<string> AllSpecialVariables = new HashSet<string>(
                typeof(SpecialVariables).GetPublicConstants<string>());
        }
    }
}
