apps/plugins/text_viewer/tv_reader.h

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2002 Gilles Roux
  11  *               2003 Garrett Derner
  12  *               2010 Yoshihisa Uchida
  13  *
  14  * This program is free software; you can redistribute it and/or
  15  * modify it under the terms of the GNU General Public License
  16  * as published by the Free Software Foundation; either version 2
  17  * of the License, or (at your option) any later version.
  18  *
  19  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  20  * KIND, either express or implied.
  21  *
  22  ****************************************************************************/
  23 #ifndef PLUGIN_TEXT_VIEWER_READER_H
  24 #define PLUGIN_TEXT_VIEWER_READER_H
  25
  26 /* stuff for the reading file */
  27
  28 /*
  29  * initialize the reader module
  30  *
  31  * return
  32  *     true  initialize success
  33  *     false initialize failure
  34  */
  35 bool tv_init_reader(void);
  36
  37 /* finalize the reader module */
  38 void tv_finalize_reader(void);
  39
  40 /*
  41  * return the file size
  42  *
  43  * return
  44  *     file size
  45  *
  46  * Note: when the file is UTF-8 file with BOM, if the encoding of the text viewer is UTF-8,
  47  * then file size decreases only BOM size.
  48  */
  49 off_t tv_get_file_size(void);
  50
  51 /*
  52  * return the whether is the end of file or not
  53  *
  54  * return
  55  *     true  EOF
  56  *     false not EOF
  57  */
  58 bool tv_is_eof(void);
  59
  60 /*
  61  * return the current file position
  62  *
  63  * return
  64  *     the current file position
  65  */
  66 off_t tv_get_current_file_pos(void);
  67
  68 /*
  69  * return the bufer which store text data
  70  *
  71  * [Out] bufsize
  72  *          buffer size
  73  *
  74  * return
  75  *     the pointer of the buffer
  76  */
  77 const unsigned char *tv_get_buffer(ssize_t *bufsize);
  78
  79 /*
  80  * seek to the given offset
  81  *
  82  * [In] offset
  83  *          offset size
  84  *
  85  * [In] whence
  86  *          SEEK_CUR  seek to the current position + offset.
  87  *          SEEK_SET  seek to the offset.
  88  *
  89  * Note: whence supports SEEK_CUR and SEEK_SET only.
  90  */
  91 void tv_seek(off_t offset, int whence);
  92
  93 #endif