apps/plugins/text_viewer/tv_text_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_TEXT_READER_H
  24 #define PLUGIN_TEXT_VIEWER_TEXT_READER_H
  25
  26 /*
  27  * initialize the text reader module
  28  *
  29  * return
  30  *     true  initialize success
  31  *     false initialize failure
  32  */
  33 bool tv_init_text_reader(void);
  34
  35 /* finalize the text reader module */
  36 void tv_finalize_text_reader(void);
  37
  38 /*
  39  * set the read conditions
  40  *
  41  * [In] blocks
  42  *          block count
  43  *
  44  * [In] width
  45  *          block width
  46  */
  47 void tv_set_read_conditions(int blocks, int width);
  48
  49 /*
  50  * return the total text size
  51  *
  52  * return
  53  *     the total text size
  54  */
  55 off_t tv_get_total_text_size(void);
  56
  57 /*
  58  * get the text of the next line
  59  *
  60  * [Out] buf
  61  *           the pointer of the pointer which store the text
  62  *
  63  * return
  64  *     true   next line exists
  65  *     false  next line does not exist
  66  */
  67 bool tv_get_next_line(const unsigned char **buf);
  68
  69 /*
  70  * start to read lines
  71  *
  72  * [In] block
  73  *          the index of block to read text
  74  *
  75  * [In] is_multi
  76  *          true  read 2 blocks
  77  *          false read 1 block
  78  */
  79 void tv_read_start(int block, bool is_multi);
  80
  81 /*
  82  * end to read lines
  83  *
  84  * return
  85  *     read text size
  86  */
  87 int tv_read_end(void);
  88
  89 /* seek to the head of the file */
  90 void tv_seek_top(void);
  91
  92 #endif