/* ====================================================================
   Licensed To the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for Additional information regarding copyright ownership.
   The ASF licenses this file To You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed To in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

namespace HH.WMS.Utils.NPOI.SS.Formula
{

    using System;
    using HH.WMS.Utils.NPOI.SS.Formula;
    using HH.WMS.Utils.NPOI.SS.Formula.Udf;
    using HH.WMS.Utils.NPOI.SS.Formula.PTG;

    public class ExternalSheet
    {
        private String _workbookName;
        private String _sheetName;

        public ExternalSheet(String workbookName, String sheetName)
        {
            _workbookName = workbookName;
            _sheetName = sheetName;
        }
        public String GetWorkbookName()
        {
            return _workbookName;
        }
        public String GetSheetName()
        {
            return _sheetName;
        }
    }
    /**
     * Abstracts a workbook for the purpose of formula evaluation.<br/>
     * 
     * For POI internal use only
     * 
     * @author Josh Micich
     */
    public interface IEvaluationWorkbook
    {
        String GetSheetName(int sheetIndex);
        /**
         * @return -1 if the specified sheet is from a different book
         */
        int GetSheetIndex(IEvaluationSheet sheet);
        int GetSheetIndex(String sheetName);

        IEvaluationSheet GetSheet(int sheetIndex);

        /**
         * @return <c>null</c> if externSheetIndex refers To a sheet inside the current workbook
         */
        ExternalSheet GetExternalSheet(int externSheetIndex);
        int ConvertFromExternSheetIndex(int externSheetIndex);
        ExternalName GetExternalName(int externSheetIndex, int externNameIndex);
        IEvaluationName GetName(NamePtg namePtg);
        IEvaluationName GetName(String name, int sheetIndex);
        String ResolveNameXText(NameXPtg ptg);
        Ptg[] GetFormulaTokens(IEvaluationCell cell);
        UDFFinder GetUDFFinder();
    }

    public class ExternalName
    {
        private String _nameName;
        private int _nameNumber;
        private int _ix;

        public ExternalName(String nameName, int nameNumber, int ix)
        {
            _nameName = nameName;
            _nameNumber = nameNumber;
            _ix = ix;
        }
        public String Name
        {
            get
            {
                return _nameName;
            }
        }
        public int Number
        {
            get
            {
                return _nameNumber;
            }
        }
        public int Ix
        {
            get
            {
                return _ix;
            }
        }
    }
}