1283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/***************************************************************************/ 2283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* */ 36e7da50bc3e972f723fd2a3754e7e1ed0e312a21Ewald Hew (Hew Yih Shiuan 丘毅宣)/* pserror.h */ 4283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* */ 5283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* Adobe's code for error handling (specification). */ 6283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* */ 7283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* Copyright 2006-2013 Adobe Systems Incorporated. */ 8283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* */ 9283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* This software, and all works of authorship, whether in source or */ 10283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* object code form as indicated by the copyright notice(s) included */ 11283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* herein (collectively, the "Work") is made available, and may only be */ 12283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* used, modified, and distributed under the FreeType Project License, */ 13283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* LICENSE.TXT. Additionally, subject to the terms and conditions of the */ 14283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* FreeType Project License, each contributor to the Work hereby grants */ 15283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* to any individual or legal entity exercising permissions granted by */ 16283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* the FreeType Project License and this section (hereafter, "You" or */ 17283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* "Your") a perpetual, worldwide, non-exclusive, no-charge, */ 18283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* royalty-free, irrevocable (except as stated in this section) patent */ 19283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* license to make, have made, use, offer to sell, sell, import, and */ 20283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* otherwise transfer the Work, where such license applies only to those */ 21283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* patent claims licensable by such contributor that are necessarily */ 22283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* infringed by their contribution(s) alone or by combination of their */ 23283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* contribution(s) with the Work to which such contribution(s) was */ 24283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* submitted. If You institute patent litigation against any entity */ 25283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* (including a cross-claim or counterclaim in a lawsuit) alleging that */ 26283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* the Work or a contribution incorporated within the Work constitutes */ 27283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* direct or contributory patent infringement, then any patent licenses */ 28283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* granted to You under this License for that Work shall terminate as of */ 29283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* the date such litigation is filed. */ 30283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* */ 31283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* By using, modifying, or distributing the Work you indicate that you */ 32283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* have read and understood the terms and conditions of the */ 33283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* FreeType Project License as well as those provided in this section, */ 34283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* and you accept them fully. */ 35283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* */ 36283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/***************************************************************************/ 37283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 38283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 39179caf5a618a684d3f8f25e0f3def3c41c2504abWerner Lemberg#ifndef PSERROR_H_ 40179caf5a618a684d3f8f25e0f3def3c41c2504abWerner Lemberg#define PSERROR_H_ 41283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 42283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 43283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg#include FT_MODULE_ERRORS_H 44283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 4537412ff9f42212bcf4dd29d9762f3c35b5735768Werner Lemberg#undef FTERRORS_H_ 46283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 47283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg#undef FT_ERR_PREFIX 48283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg#define FT_ERR_PREFIX CF2_Err_ 49283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg#define FT_ERR_BASE FT_Mod_Err_CF2 50283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 51283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 52283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg#include FT_ERRORS_H 53766f529a3109870f5921ff812e9b7832263c0fbcEwald Hew (Hew Yih Shiuan 丘毅宣)#include "psft.h" 54283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 55283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 56283c8ed817a645dfd08b5e1fe78a34bd91140389Werner LembergFT_BEGIN_HEADER 57283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 58283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 59283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg /* 60283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * A poor-man error facility. 61283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 62283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * This code being written in vanilla C, doesn't have the luxury of a 63283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * language-supported exception mechanism such as the one available in 64283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * Java. Instead, we are stuck with using error codes that must be 65283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * carefully managed and preserved. However, it is convenient for us to 66283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * model our error mechanism on a Java-like exception mechanism. 67283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * When we assign an error code we are thus `throwing' an error. 68283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 69a32270ae0e540900e8f240ec2be82bfdeb7546b7Alexei Podtelezhnikov (Алексей Подтележников) * The preservation of an error code is done by coding convention. 70283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * Upon a function call if the error code is anything other than 71283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * `FT_Err_Ok', which is guaranteed to be zero, we 72283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * will return without altering that error. This will allow the 73e85422606d8d2f6a1d69eea0a7c5dcdc0470c985Alexei Podtelezhnikov (Алексей Подтележников) * error to propagate and be handled at the appropriate location in 74283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * the code. 75283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 76283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * This allows a style of code where the error code is initialized 77283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * up front and a block of calls are made with the error code only 78283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * being checked after the block. If a new error occurs, the original 79283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * error will be preserved and a functional no-op should result in any 80283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * subsequent function that has an initial error code not equal to 81283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * `FT_Err_Ok'. 82283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 83283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * Errors are encoded by calling the `FT_THROW' macro. For example, 84283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 85283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * { 86283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * FT_Error e; 87283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 88283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 89283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * ... 90283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * e = FT_THROW( Out_Of_Memory ); 91283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * } 92283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 93283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg */ 94283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 95283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 96283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg /* Set error code to a particular value. */ 97283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg FT_LOCAL( void ) 98283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg cf2_setError( FT_Error* error, 99283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg FT_Error value ); 100283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 101283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 102283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg /* 103283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * A macro that conditionally sets an error code. 104283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 105283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * This macro will first check whether `error' is set; 106283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * if not, it will set it to `e'. 107283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg * 108283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg */ 109283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg#define CF2_SET_ERROR( error, e ) \ 110283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg cf2_setError( error, FT_THROW( e ) ) 111283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 112283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 113283c8ed817a645dfd08b5e1fe78a34bd91140389Werner LembergFT_END_HEADER 114283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 115283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 116179caf5a618a684d3f8f25e0f3def3c41c2504abWerner Lemberg#endif /* PSERROR_H_ */ 117283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 118283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg 119283c8ed817a645dfd08b5e1fe78a34bd91140389Werner Lemberg/* END */ 120