shell/source/unix/sysshell/recently_used_file.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: recently_used_file.hxx,v $
  10  * $Revision: 1.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef INCLUDED_RECENTLY_USED_FILE_HXX
  32 #define INCLUDED_RECENTLY_USED_FILE_HXX
  33
  34 #include <stdio.h>
  35 #include <unistd.h>
  36
  37 //##################################
  38 // simple wrapper around the recently_used_file
  39
  40 class recently_used_file
  41 {
  42 public:
  43     //----------------------------
  44     recently_used_file();
  45
  46     //----------------------------
  47     ~recently_used_file();
  48
  49     //----------------------------
  50     // set file pointer to the start of file
  51     void reset() const;
  52
  53     //----------------------------
  54     void truncate(off_t length = 0);
  55
  56     //----------------------------
  57     void flush();
  58
  59     //----------------------------
  60     size_t read(
  61         char* buffer,
  62         size_t size) const;
  63
  64     //----------------------------
  65     void write(const char* buffer, size_t size) const;
  66
  67     //----------------------------
  68     bool eof() const;
  69
  70 private:
  71     FILE* file_;
  72 };
  73
  74 #endif // INCLUDED_RECENTLY_USED_FILE_HXX