/***************************************************************************************
 *
 *  WRITEPAD(r): Handwriting Recognition Engine (HWRE) and components.
 *  Copyright (c) 2001-2016 PhatWare (r) Corp. All rights reserved.
 *
 *  Licensing and other inquires: <developer@phatware.com>
 *  Developer: Stan Miasnikov, et al. (c) PhatWare Corp. <http://www.phatware.com>
 *
 *  WRITEPAD HWRE is free software: you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation, either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  THE MATERIAL EMBODIED ON THIS SOFTWARE IS PROVIDED TO YOU "AS-IS"
 *  AND WITHOUT WARRANTY OF ANY KIND, EXPRESS, IMPLIED OR OTHERWISE,
 *  INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR
 *  FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL PHATWARE CORP.
 *  BE LIABLE TO YOU OR ANYONE ELSE FOR ANY DIRECT, SPECIAL, INCIDENTAL,
 *  INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES WHATSOEVER,
 *  INCLUDING WITHOUT LIMITATION, LOSS OF PROFIT, LOSS OF USE, SAVINGS
 *  OR REVENUE, OR THE CLAIMS OF THIRD PARTIES, WHETHER OR NOT PHATWARE CORP.
 *  HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH LOSS, HOWEVER CAUSED AND ON
 *  ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
 *  POSSESSION, USE OR PERFORMANCE OF THIS SOFTWARE.
 *  See the GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with WritePad.  If not, see <http://www.gnu.org/licenses/>.
 *
 **************************************************************************************/

#ifndef FILE_DEFINED        /*  See #endif in the end of file.  */
#define FILE_DEFINED

#include "bastypes.h"
#include "hwr_sys.h"

#ifndef  HFILE_TO_VALUE
typedef  p_VOID  _HFILE;
#define  VALUE_TO_HFILE VALUE_TO_PTR
#define  HFILE_TO_VALUE PTR_TO_VALUE
#endif
typedef  _HFILE _PTR           p_HFILE;

#ifndef  HTEXT_TO_VALUE
typedef  p_VOID  _HTEXT;
#define  VALUE_TO_HTEXT VALUE_TO_PTR
#define  HTEXT_TO_VALUE PTR_TO_VALUE
#endif
typedef  _HTEXT _PTR           p_HTEXT;

#ifndef  HFIND_TO_VALUE
typedef  _HMEM _HFIND;
#define  VALUE_TO_HFIND VALUE_TO_HMEM
#define  HFIND_TO_VALUE HMEM_TO_VALUE
#endif
typedef  _HFIND _PTR           p_HFIND;

#ifndef  HSEEK_TO_VALUE
typedef  _LONG  _HSEEK;
#define  VALUE_TO_HSEEK VALUE_TO_LONG
#define  HSEEK_TO_VALUE LONG_TO_VALUE
#endif
typedef  _HSEEK _PTR           p_HSEEK;

/* Values available for Open (parameter wRdWrAccess HWRFileOpend and
   HWRTextOpen) */
#define HWR_FILE_NORMAL 0
#define HWR_FILE_RDWR   0
#define HWR_FILE_RDONLY 1
#define HWR_FILE_WRONLY 2

#define HWR_TEXT_NORMAL 0
#define HWR_TEXT_RDWR   0
#define HWR_TEXT_RDONLY 1
#define HWR_TEXT_WRONLY 2

/* Origin constants for seek (parameter wOrigin in function HWRFileSeek) */
#define HWR_FILE_SEEK_SET 0
#define HWR_FILE_SEEK_CUR 1
#define HWR_FILE_SEEK_END 2

/* Constants for seek (parameter hSeek in function HWRTextSeek) */
#define HWR_TEXT_SEEK_BEGIN   ((_LONG)(-2L))
#define HWR_TEXT_SEEK_END     ((_LONG)(-3L))

/* EOF constants */
#define HWR_FILE_EOF   ((_WORD)(_INT)-1)
#define HWR_TEXT_EOF   ((_WORD)(_INT)-1)

/* Open mode for file functions (parameter wOpenMode in function HWRFileOpen) */
#define HWR_FILE_EXIST_OPEN      0x01
#define HWR_FILE_EXIST_CREATE    0x02
#define HWR_FILE_EXIST_ERROR     0x03
#define HWR_FILE_EXIST_UNIQUE    0x04
#define HWR_FILE_EXIST_APPEND    0x05
#define HWR_FILE_NOTEXIST_CREATE 0x10
#define HWR_FILE_NOTEXIST_ERROR  0x20
#define HWR_FILE_EXIST_MASK      0x0F
#define HWR_FILE_NOTEXIST_MASK   0xF0

#define HWR_FILE_EXCL      (HWR_FILE_EXIST_OPEN|HWR_FILE_NOTEXIST_ERROR)
#define HWR_FILE_OPEN      (HWR_FILE_EXIST_OPEN|HWR_FILE_NOTEXIST_CREATE)
#define HWR_FILE_CREAT     HWR_FILE_OPEN
#define HWR_FILE_TRUNC     (HWR_FILE_EXIST_CREATE|HWR_FILE_NOTEXIST_CREATE)
#define HWR_FILE_APPEND    (HWR_FILE_EXIST_APPEND|HWR_FILE_NOTEXIST_CREATE)

/* Open mode for text functions (parameter wOpenMode in function HWRTextOpen) */
#define HWR_TEXT_EXIST_OPEN      0x01
#define HWR_TEXT_EXIST_CREATE    0x02
#define HWR_TEXT_EXIST_ERROR     0x03
#define HWR_TEXT_EXIST_UNIQUE    0x04
#define HWR_TEXT_EXIST_APPEND    0x05
#define HWR_TEXT_NOTEXIST_CREATE 0x10
#define HWR_TEXT_NOTEXIST_ERROR  0x20
#define HWR_TEXT_EXIST_MASK      0x0F
#define HWR_TEXT_NOTEXIST_MASK   0xF0

#define HWR_TEXT_EXCL      (HWR_TEXT_EXIST_OPEN|HWR_TEXT_NOTEXIST_ERROR)
#define HWR_TEXT_OPEN      (HWR_TEXT_EXIST_OPEN|HWR_TEXT_NOTEXIST_CREATE)
#define HWR_TEXT_CREAT     HWR_TEXT_OPEN
#define HWR_TEXT_TRUNC     (HWR_TEXT_EXIST_CREATE|HWR_TEXT_NOTEXIST_CREATE)
#define HWR_TEXT_APPEND    (HWR_TEXT_EXIST_APPEND|HWR_TEXT_NOTEXIST_CREATE)

/* Binary file functions */

_HFILE  HWRFileOpen(_STR zPathName, _WORD wRdWrAccess, _WORD wOpenMode);
/* €ÂÂa¶—‡„Â, §Ç¼–‡„Â ·‡Ñ2. wRdWrAccess - §ÈÇ§Ç’ –Ç§Â¹È‡ - ÈÇ  Â„ÁÀE,
   ¼‡ÈÀ§À À2À Ç’ÁÇ—2„ÁÀE. wOpenMode - Â‡Â ÇÂÂa¶—‡Â° ·‡Ñ2. ƒ„ÂÇ4„Á–¹„Â§U
   À§ÈÇ2°¼Ç—‡Â° ÂÇ4’ÀÁÀaÇ—‡ÁÁ¶„ —‡aÀ‡ÁÂ¶:
   HWR_FILE_EXCL - ÇÂÂa¶—‡„Â ÂÇ2°ÂÇ §¹¼„§Â—¹E¼ÀÑ ·‡Ñ2, „§2À „œÇ Á„Â, ÂÇ ÇÛÀ’Â‡.
   HWR_FILE_OPEN - „§2À ·‡Ñ2‡ Á„Â, ÂÇ ÇÁ §Ç¼–‡„Â§U. ˆ§2À „§Â° - ÇÂÂa¶—‡„Â§U.
   HWR_FILE_CREAT - ÂÇ »„,  ÂÇ À HWR_FILE_OPEN.
   HWR_FILE_TRUNC - š‡Ñ2 §Ç¼–‡„Â§U ¼‡ÁÇ—Ç Á„¼‡—À§À4Ç ÇÂ ÂÇœÇ „§Â° ÇÁ À2À Á„Â.
   HWR_FILE_APPEND - ®‡Â» Â‡Â À HWR_FILE_OPEN, ÁÇ ÈÇ§2„ ÇÂÂa¶ÂÀU ¹Â‡¼‡Â„2°
    Â„ÁÀU/¼‡ÈÀ§À ¹Â‡¼¶—‡„Â Á‡ ÂÇÁ„µ ·‡Ñ2‡.
	ŽÇ¼—a‡Â - Handle À2À _NULL ÈaÀ ÇÛÀ’Â„
	*/

_WORD  HWRFileRead(_HFILE hFile, p_VOID pReadBuffer,
                   _WORD wNumberOfBytes);
/* Â„ÁÀ„ À¼ ·‡Ñ2‡ ’‡ÑÂ. ŽÇ¼—a‡¼‡„Â  À§2Ç § ÀÂ‡ÁÁ¶o ’‡ÑÂ (0 „§2À ÁÀ „ÂÇ Á„
   § ÀÂ‡2Ç§° ÈaÀ ÇÛÀ’Â„ À2À ÂÇÁµ„ ·‡Ñ2‡.
   */

_WORD HWRFileWrite(_HFILE hFile, p_VOID pWriteBuffer,
                   _WORD wNumberOfBytes);
/* ‡ÈÀ§° — ·‡Ñ2 ’‡ÑÂ. ŽÇ¼—a‡¼‡„Â  À§2Ç ¼‡ÈÀ§‡ÁÁ¶o ’‡ÑÂ (0 „§2À ÁÀ „ÂÇ Á„
   ¼‡ÈÀ§‡2Ç§° ÈaÀ ÇÛÀ’Â„ À2À ÂÇÁµ„ 4„§Â‡ Á‡ ÁÇ§ÀÂ„2„.
   */

/* _WORD HWRFileXRead (_HFILE hFile, p_VOID pReadBuffer,
							  _WORD wNumberOfBytes); */

/* _WORD HWRFileXWrite (_HFILE hFile, p_VOID pReadBuffer,
							  _WORD wNumberOfBytes); */

_BOOL HWRFileSeek(_HFILE hFile, _LONG lOffset, _WORD wOrigin);
/* ™§Â‡ÁÇ—Â‡ ¹Â‡¼‡Â„2U  Â„ÁÀU/¼‡ÈÀ§À — ÈÇ2Ç»„ÁÀ„ lOffset ÈÇ 4„ÂÇ–¹ wOrigin.
   ŽÇ¼—a‡¼‡„Â _TRUE „§2À —§„ ÈaÇÛ2Ç ÁÇa4‡2°ÁÇ À _FALSE „§2À ÇÛÀ’Â‡.
   */

_LONG HWRFileTell(_HFILE hFile);
/* ŽÇ¼—a‡¼‡„Â Â„Â¹¼¹E ÈÇ¼ÀµÀE ·‡Ñ2‡ À2À -1L „§2À ÇÛÀ’Â‡ À2À ÈÇ¼ÀµÀU Á„
   ÇÈa„–„2„Á‡.
   */

_BOOL  HWRFileEOF(_HFILE hFile);
/* ŽÇ¼—a‡¼‡„Â Á„ _NULL „§2À ¹Â‡¼‡Â„2°  Â„ÁÀU/¼‡ÈÀ§À Á‡ ÂÇÁµ„ ·‡Ñ2‡ À _NULL
   — ÈaÇÂÀ—ÁÇ4 §2¹ ‡„.
   */

_BOOL HWRFileClose(_HFILE hFile);
/* ‡Âa¶—‡„Â ·‡Ñ2. ŽÇ¼—a‡¼‡„Â _NULL ÈaÀ ÇÛÀ’Â„, _TRUE ÈaÀ ¹§È„o„.
*/

/* Text file functions */

_HTEXT HWRTextOpen (_STR zPathName, _WORD wRdWrAccess, _WORD wOpenMode);
/* €ÂÂa¶—‡„Â, §Ç¼–‡„Â ·‡Ñ2. wRdWrAccess - §ÈÇ§Ç’ –Ç§Â¹È‡ - ÈÇ  Â„ÁÀE,
   ¼‡ÈÀ§À À2À Ç’ÁÇ—2„ÁÀE. wOpenMode - Â‡Â ÇÂÂa¶—‡Â° ·‡Ñ2. ƒ„ÂÇ4„Á–¹„Â§U
   À§ÈÇ2°¼Ç—‡Â° ÂÇ4’ÀÁÀaÇ—‡ÁÁ¶„ —‡aÀ‡ÁÂ¶:
   HWR_TEXT_EXCL - ÇÂÂa¶—‡„Â ÂÇ2°ÂÇ §¹¼„§Â—¹E¼ÀÑ ·‡Ñ2, „§2À „œÇ Á„Â, ÂÇ ÇÛÀ’Â‡.
   HWR_TEXT_OPEN - „§2À ·‡Ñ2‡ Á„Â, ÂÇ ÇÁ §Ç¼–‡„Â§U. ˆ§2À „§Â° - ÇÂÂa¶—‡„Â§U.
   HWR_TEXT_CREAT - ÂÇ »„,  ÂÇ À HWR_TEXT_OPEN.
   HWR_TEXT_TRUNC - š‡Ñ2 §Ç¼–‡„Â§U ¼‡ÁÇ—Ç Á„¼‡—À§À4Ç ÇÂ ÂÇœÇ „§Â° ÇÁ À2À Á„Â.
   HWR_TEXT_APPEND - ®‡Â» Â‡Â À HWR_TEXT_OPEN, ÁÇ ÈÇ§2„ ÇÂÂa¶ÂÀU ¹Â‡¼‡Â„2°
    Â„ÁÀU/¼‡ÈÀ§À ¹Â‡¼¶—‡„Â Á‡ ÂÇÁ„µ ·‡Ñ2‡.
	ŽÇ¼—a‡Â - Handle À2À _NULL ÈaÀ ÇÛÀ’Â„
	*/

#if HWR_SYSTEM == HWR_MACINTOSH
_WORD  _FVPREFIX HWRTextPrintf(_HTEXT hText, _STR pFormatString, ...);
/* €’¶ Á¶Ñ printf. ŽÇ¼—a‡¼‡„Â  À§2Ç —¶—„–„ÁÁ¶o §À4—Ç2Ç—, ‡ ÈaÀ ÇÛÀ’Â„ -
   HWR_TEXT_EOF.
   */

_WORD _FVPREFIX HWRTextSPrintf(p_CHAR pcBuffer, _STR pFormatString, ...);
/* €’¶ Á¶Ñ sprintf. ŽÇ¼—a‡¼‡„Â  À§2Ç —¶—„–„ÁÁ¶o §À4—Ç2Ç—, ‡ ÈaÀ ÇÛÀ’Â„ -
   HWR_TEXT_EOF.
   */
#else
#define HWRTextSPrintf sprintf
#define HWRTextPrintf  fprintf
#endif /* HWR_SYSTEM */
/* _WORD    _FVPREFIX HWRTextScanf (_HTEXT hText, _STR pFormatString, ... ); */
/* ÇÂ‡ Á„ a‡’ÇÂ‡„Â.
*/

/* _WORD HWRTextGetLine (_HTEXT hText, p_VOID pBuffer); */
/* š¹ÁÂµÀU —¶ÂÀÁ¹Â‡ —ÇÇ’¼„ - À§ÈÇ2°¼¹ÑÂ„ HWRTextGetS.
*/

_WORD HWRTextGetC(_HTEXT hText);
/* Ž—Ç– §À4—Ç2‡. aÇÀ¼—Ç–ÀÂ§U Âa‡Á§2UµÀU \r\n. ŽÇ¼—a‡¼‡„Â ——„–„ÁÁ¶Ñ §À4—Ç2,
   ‡ ÈaÀ ÇÛÀ’Â„ HWR_TEXT_EOF.
   */

_WORD HWRTextPutC(_WORD wChar, _HTEXT hText);
/* Ž¶—Ç– §À4—Ç2‡. aÇÀ¼—Ç–ÀÂ§U Âa‡Á§2UµÀU \r\n. ŽÇ¼—a‡¼‡„Â —¶—„–„ÁÁ¶Ñ §À4—Ç2,
   ‡ ÈaÀ ÇÛÀ’Â„ HWR_TEXT_EOF.
   */

_STR HWRTextGetS(_STR zStr, _WORD wMaxSize, _HTEXT hText);
/* Ž—Ç– §ÂaÇÂÀ. aÇÀ¼—Ç–ÀÂ§U Âa‡Á§2UµÀU \r\n. wMaxSize - a‡¼4„a ’¹·„a‡ –2U
   ÈaÀ„4‡ §ÂaÇÂÀ (Á„ ¼‡’¹–°Â„ Ç \0, ÂÇÂÇa¶Ñ —§„œ–‡ –Ç’‡—2U„Â§U — ÂÇÁµ„ -
   –2U Á„œÇ ÂÇ»„ Á‡–Ç 4„§ÂÇ). ŽÇ¼—a‡¼‡„Â§U _NULL ÈaÀ ÇÛÀ’Â„ À zStr ÈaÀ
   ¹–‡ „. ™–‡ À Ž‡4!
   */

_BOOL HWRTextPutS(_STR zStr, _HTEXT hText);
/* Ž¶—Ç– §ÂaÇÂÀ. aÇÀ¼—Ç–ÀÂ§U Âa‡Á§2UµÀU \r\n. ŽÇ¼—a‡¼‡„Â§U _NULL ÈaÀ
   ÇÛÀ’Â„ À _TRUE ÈaÀ ¹§È„o„.
   */

_BOOL HWRTextEOF(_HTEXT hText);
/* ŽÇ¼—a‡¼‡„Â Á„ _NULL „§2À ¹Â‡¼‡Â„2°  Â„ÁÀU/¼‡ÈÀ§À Á‡ ÂÇÁµ„ ·‡Ñ2‡ À _NULL
   — ÈaÇÂÀ—ÁÇ4 §2¹ ‡„.
   */

_HSEEK HWRTextTell(_HTEXT hText);
/* €Èa‡ÛÀ—‡„Â Â„Â¹¼¹E ÈÇ¼ÀµÀE ·‡Ñ2‡ –2U ÂÇœÇ,  ÂÇ’¶ — ’¹–¹¼„4 ÈÇÈ‡§Â°
   Â¹–‡ »„ (ÂÇ2°ÂÇ Â¹–‡ »„!). ŽÇ¼—a‡¼‡„Â _NULL ÈaÀ ÇÛÀ’Â„ À Á„ÂÀÑ handle
   ÈaÀ ¹§È„o„. ´ÂÇÂ handle 4Ç»ÁÇ À§ÈÇ2°¼Ç—‡Â° ÂÇ2°ÂÇ — ·¹ÁÂµÀÀ HWRTextSeek.
   */

_BOOL HWRTextSeek(_HTEXT hText, _HSEEK hSeek);
/* ™§Â‡Á‡—2À—‡„Â ·‡Ñ2 — ÈÇ¼ÀµÀE ÇÈa„–„2U„4¹E hSeek. hSeek - 2À’Ç a„¼¹2°Â‡Â
   —¶ÈÇ2Á„ÁÀU HWRTextTell, 2À ’Ç Ç–Á‡ À¼ ÂÇÁ§Â‡ÁÂ HWR_TEXT_SEEK_BEGIN
   À2À HWR_TEXT_SEEK_END. €’a‡ÂÀÂ„ —ÁÀ4‡ÁÀ„,  ÂÇ ¹ ÂÇÁ§Â‡ÁÂ
   HWR_FILE_SEEK_END À HWR_TEXT_SEEK_END ÈÇoÇ»À„ À4„Á‡, ÁÇ §Ç—„aÛ„ÁÁÇ
   a‡¼Á¶Ñ §4¶§2 À, §ÇÇÂ—„Â§Â—„ÁÁÇ, a‡¼ÁÇ„ —Á¹Âa„ÁÁ„„ ¼Á‡ „ÁÀ„ À ÂÀÈ.
   */

_BOOL HWRTextClose(_HTEXT hText);
/* ‡Âa¶—‡„Â ·‡Ñ2. ŽÇ¼—a‡¼‡„Â _NULL ÈaÀ ÇÛÀ’Â„, _TRUE ÈaÀ ¹§È„o„.
*/


typedef struct
{
	_STR    zFileName;
	_LONG   lFileSize;
} _FileFind, _PTR p_FileFind;

_HFIND HWRFileFindOpen(_STR zPathName, _WORD wAttr);
p_FileFind  HWRFileFind(_HFIND hFind);
_BOOL  HWRFileFindClose(_HFIND hFind);

#endif  /*  FILE_DEFINED  */