/******************************************************************************

 *

 * Module Name: aslascii - ASCII detection and support routines

 *

 *****************************************************************************/

/*

 * Copyright (C) 2000 - 2018, Intel Corp.

 * 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,

 *    without modification.

 * 2. Redistributions in binary form must reproduce at minimum a disclaimer

 *    substantially similar to the "NO WARRANTY" disclaimer below

 *    ("Disclaimer") and any redistribution must be conditioned upon

 *    including a substantially similar Disclaimer requirement for further

 *    binary redistribution.

 * 3. Neither the names of the above-listed copyright holders nor the names

 *    of any contributors may be used to endorse or promote products derived

 *    from this software without specific prior written permission.

 *

 * Alternatively, this software may be distributed under the terms of the

 * GNU General Public License ("GPL") version 2 as published by the Free

 * Software Foundation.

 *

 * NO WARRANTY

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR 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 DAMAGES.

 */

#include "aslcompiler.h"

#include <actables.h>

#include <acapps.h>

#define _COMPONENT          ACPI_COMPILER

        ACPI_MODULE_NAME    ("aslascii")

/* Local prototypes */

static void

FlConsumeAnsiComment (

    FILE                    *Handle,

    ASL_FILE_STATUS         *Status);

static void

FlConsumeNewComment (

    FILE                    *Handle,

    ASL_FILE_STATUS         *Status);

/*******************************************************************************

 *

 * FUNCTION:    FlIsFileAsciiSource

 *

 * PARAMETERS:  Filename            - Full input filename

 *              DisplayErrors       - TRUE if error messages desired

 *

 * RETURN:      Status

 *

 * DESCRIPTION: Verify that the input file is entirely ASCII. Ignores characters

 *              within comments. Note: does not handle nested comments and does

 *              not handle comment delimiters within string literals. However,

 *              on the rare chance this happens and an invalid character is

 *              missed, the parser will catch the error by failing in some

 *              spectactular manner.

 *

 ******************************************************************************/

ACPI_STATUS

FlIsFileAsciiSource (

    char                    *Filename,

    BOOLEAN                 DisplayErrors)

{

    UINT8                   Byte;

    UINT32                  BadBytes = 0;

    BOOLEAN                 OpeningComment = FALSE;

    ASL_FILE_STATUS         Status;

    FILE                    *Handle;

    /* Open file in text mode so file offset is always accurate */

    Handle = fopen (Filename, "rb");

    if (!Handle)

    {

        perror ("Could not open input file");

        return (AE_ERROR);

    }

    Status.Line = 1;

    Status.Offset = 0;

    /* Read the entire file */

    while (fread (&Byte, 1, 1, Handle) == 1)

    {

        /* Ignore comment fields (allow non-ascii within) */

        if (OpeningComment)

        {

            /* Check for second comment open delimiter */

            if (Byte == '*')

            {

                FlConsumeAnsiComment (Handle, &Status);

            }

            if (Byte == '/')

            {

                FlConsumeNewComment (Handle, &Status);

            }

            /* Reset */

            OpeningComment = FALSE;

        }

        else if (Byte == '/')

        {

            OpeningComment = TRUE;

        }

        /* Check for an ASCII character */

        if (!ACPI_IS_ASCII (Byte))

        {

            if ((BadBytes < 10) && (DisplayErrors))

            {

                AcpiOsPrintf (

                    "Found non-ASCII character in source text: "

                    "0x%2.2X in line %u, file offset 0x%2.2X\n",

                    Byte, Status.Line, Status.Offset);

            }

            BadBytes++;

        }

        /* Ensure character is either printable or a "space" char */

        else if (!isprint (Byte) && !isspace (Byte))

        {

            if ((BadBytes < 10) && (DisplayErrors))

            {

                AcpiOsPrintf (

                    "Found invalid character in source text: "

                    "0x%2.2X in line %u, file offset 0x%2.2X\n",

                    Byte, Status.Line, Status.Offset);

            }

            BadBytes++;

        }

        /* Update line counter as necessary */

        if (Byte == 0x0A)

        {

            Status.Line++;

        }

        Status.Offset++;

    }

    fclose (Handle);

    /* Were there any non-ASCII characters in the file? */

    if (BadBytes)

    {

        fprintf (stderr,

            "File appears to be binary: found %u non-ASCII characters, disassembling\n",

            BadBytes);

        if (DisplayErrors)

        {

            AcpiOsPrintf (

                "Total %u invalid characters found in input source text, "

                "could be a binary file\n", BadBytes);

            AslError (ASL_ERROR, ASL_MSG_NON_ASCII, NULL, Filename);

        }

        return (AE_BAD_CHARACTER);

    }

    /* File is OK (100% ASCII) */

    return (AE_OK);

}

/*******************************************************************************

 *

 * FUNCTION:    FlConsumeAnsiComment

 *

 * PARAMETERS:  Handle              - Open input file

 *              Status              - File current status struct

 *

 * RETURN:      Number of lines consumed

 *

 * DESCRIPTION: Step over a normal slash-star type comment

 *

 ******************************************************************************/

static void

FlConsumeAnsiComment (

    FILE                    *Handle,

    ASL_FILE_STATUS         *Status)

{

    UINT8                   Byte;

    BOOLEAN                 ClosingComment = FALSE;

    while (fread (&Byte, 1, 1, Handle) == 1)

    {

        /* Scan until comment close is found */

        if (ClosingComment)

        {

            if (Byte == '/')

            {

                Status->Offset++;

                return;

            }

            if (Byte != '*')

            {

                /* Reset */

                ClosingComment = FALSE;

            }

        }

        else if (Byte == '*')

        {

            ClosingComment = TRUE;

        }

        /* Maintain line count */

        if (Byte == 0x0A)

        {

            Status->Line++;

        }

        Status->Offset++;

    }

}

/*******************************************************************************

 *

 * FUNCTION:    FlConsumeNewComment

 *

 * PARAMETERS:  Handle              - Open input file

 *              Status              - File current status struct

 *

 * RETURN:      Number of lines consumed

 *

 * DESCRIPTION: Step over a slash-slash type of comment

 *

 ******************************************************************************/

static void

FlConsumeNewComment (

    FILE                    *Handle,

    ASL_FILE_STATUS         *Status)

{

    UINT8                   Byte;

    while (fread (&Byte, 1, 1, Handle) == 1)

    {

        Status->Offset++;

        /* Comment ends at newline */

        if (Byte == 0x0A)

        {

            Status->Line++;

            return;

        }

    }

}