/*
$Header: jetasmf.h,v 1.1 96/03/16 19:26:45 barry Exp $
*/
 /**************************************************************************
 *
 *   (c) Copyright Hewlett-Packard Company, 1995.  All rights are
 *   reserved.  Copying or other reproduction of this program except
 *   for archival purposes is prohibited without the prior written
 *   consent of Hewlett-Packard Company.
 *
 *                   RESTRICTED RIGHTS LEGEND
 *
 *   Use, duplication, or disclosure by the Government is subject to
 *   restrictions as set forth in paragraph (b) (3) (B) of the Rights
 *   in Technical Data and Computer Software clause in DAR 7-104.9(a).
 *
 *   HEWLETT-PACKARD COMPANY
 *   Boise, Idaho, USA
 ***************************************************************************/

/*
******************************* NOTICE ***************************************

HEWLETT-PACKARD COMPANY MAKES NO WARRANTIES, EXPRESS OR IMPLIED,  
INCLUDING WITHOUT LIMITATION THE IMPLIED WARRANTIES OF 
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE, REGARDING THE 
SOFTWARE OR TECHNICAL INFORMATION.   HEWLETT-PACKARD COMPANY DOES 
NOT WARRANT, GUARANTEE OR MAKE ANY REPRESENTATIONS REGARDING THE 
USE OR THE RESULTS OF THE USE OF THE SOFTWARE OR TECHNICAL 
INFORMATION IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY, 
CURRENTNESS, OR OTHERWISE.   THE ENTIRE RISK AS TO THE RESULTS AND 
PERFORMANCE OF THE SOFTWARE OR TECHNICAL INFORMATION IS ASSUMED 
BY YOU.  The exclusion of implied warranties is not permitted by some 
jurisdictions.  The above exclusion may not apply to you.

IN NO EVENT WILL HEWLETT-PACKARD COMPANY BE LIABLE TO YOU FOR ANY 
CONSEQUENTIAL, INCIDENTAL OR INDIRECT DAMAGES (INCLUDING DAMAGES 
FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS 
INFORMATION AND THE LIKE)  ARISING OUT OF THE USE OR INABILITY TO USE 
THE SOFTWARE OR TECHNICAL INFORMATION EVEN IF HEWLETT-PACKARD HAS 
BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.  Because some jurisdictions 
do not allow the exclusion or limitation of liability for consequential 
or incidental damages, the above limitations may not apply to you.  
Hewlett-Packard liability to you for actual damages from any cause whatsoever,
 and regardless of the form of the action (whether in contract, tort 
including negligence, product liability or otherwise), will be limited 
to US $50.

Copyright (c) 1995 Hewlett-Packard Company.  All rights reserved.

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

/* the following are #defines and typedefs for managing 
 * file input/output
 */
#define MAX_PATH 127
#define MAX_FILE_NAME 127
#define MAX_FILE_PATH (MAX_FILE_NAME + MAX_PATH)
#define MAX_NESTED_FILES 14 
#define MAX_PATHS 15

typedef HP_pUByte HP_pChar; /* define basic pointer to characters */

/* the following enum is used to instruct the disassembler what to do: */
typedef enum {eDisAsmOnly, eDisAsmAndStat, eDisAsmStatOnly, eDisAsmCoverage} DisAsmEnumType;

/* the following is the structure definition for
 * $include file paths
 */
typedef struct {
    int numFilePaths;
    HP_pChar pathArray[MAX_PATHS];
} PathList;

typedef PathList *PathListPtrType;

/* the following initializes the $include path list */
#define INIT_PATH_LIST(pPathList) \
{\
    pPathList->numFilePaths = 1;\
    pPathList->pathArray[0] = ".";\
}

typedef int SInt16FuncReturnType;
typedef void StdFuncReturnType;

#define ASSEMBLY_ABORTED \
    sprintf(sprintfBuff, "No Assembly Output Generated.  Assembly Aborted.\n");\
    HP_LogError(sprintfBuff);
    
#define ASSEMBLY_SUCCESSFUL \
    sprintf(sprintfBuff, "No Errors Detected.  Assembly Successful.\n");\
    HP_LogMsg(sprintfBuff);

#define DISASSEMBLY_ABORTED \
    sprintf(sprintfBuff, "No Disassembly Output Generated.  Disassembly Aborted.\n");\
    HP_LogError(sprintfBuff);
    
#define DISASSEMBLY_SUCCESSFUL \
    sprintf(sprintfBuff, "No Errors Detected.  Disassembly Successful.\n");\
    HP_LogMsg(sprintfBuff);

StdFuncReturnType ParseAssembly(HP_StreamHandleType pStream, HP_pChar inFileName,
                                PathListPtrType pPathList);
 
StdFuncReturnType ParseStream(HP_StreamHandleType pStream, HP_pChar inFileName,
                              PathListPtrType pPathList,
                              DisAsmEnumType disAsmEnum);
 
StdFuncReturnType printDoc(void);
                                 
SInt16FuncReturnType HP_EscapeMacro(HP_StreamHandleType pStream, 
                                    HP_pUByte escapeName, HP_pUByte macroBody,
                                    HP_pUByte returnString, HP_UInt16 returnStringMax);

StdFuncReturnType HP_LogMsg(HP_pUByte outBuff);

StdFuncReturnType HP_LogError(HP_pUByte outBuff);

SInt16FuncReturnType HP_ReadInputString( 
                                          HP_pUByte returnString,
                                          HP_UInt16 returnStringLen
                                       );