Browse Source

Added fopen/fread/fwrite/fgets wrapper class.

Tatsuhiro Tsujikawa 14 years ago
parent
commit
6cb91cae88
5 changed files with 240 additions and 2 deletions
  1. 100 0
      src/BufferedFile.cc
  2. 78 0
      src/BufferedFile.h
  3. 2 1
      src/Makefile.am
  4. 58 0
      test/BufferedFileTest.cc
  5. 2 1
      test/Makefile.am

+ 100 - 0
src/BufferedFile.cc

@@ -0,0 +1,100 @@
+/* <!-- copyright */
+/*
+ * aria2 - The high speed download utility
+ *
+ * Copyright (C) 2011 Tatsuhiro Tsujikawa
+ *
+ * This program 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 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of portions of this program with the
+ * OpenSSL library under certain conditions as described in each
+ * individual source file, and distribute linked combinations
+ * including the two.
+ * You must obey the GNU General Public License in all respects
+ * for all of the code used other than OpenSSL.  If you modify
+ * file(s) with this exception, you may extend this exception to your
+ * version of the file(s), but you are not obligated to do so.  If you
+ * do not wish to do so, delete this exception statement from your
+ * version.  If you delete this exception statement from all source
+ * files in the program, then also delete it here.
+ */
+/* copyright --> */
+#include "BufferedFile.h"
+
+#include <cstring>
+
+#include "a2io.h"
+#include "util.h"
+
+namespace aria2 {
+
+const std::string BufferedFile::READ = "rb";
+const std::string BufferedFile::WRITE = "wb";
+
+BufferedFile::BufferedFile(const std::string& filename, const std::string& mode)
+{
+  fp_ = a2fopen(utf8ToWChar(filename).c_str(), utf8ToWChar(mode).c_str());
+  open_ = fp_;
+}
+
+BufferedFile::~BufferedFile()
+{
+  close();
+}
+
+BufferedFile::operator unspecified_bool_type() const
+{
+  return (!open_ || ferror(fp_) || feof(fp_)) ? 0 : &BufferedFile::good_state;
+}
+
+size_t BufferedFile::read(void* ptr, size_t count)
+{
+  return fread(ptr, 1, count, fp_);
+}
+
+size_t BufferedFile::write(const void* ptr, size_t count)
+{
+  return fwrite(ptr, 1, count, fp_);
+}
+
+char* BufferedFile::gets(char* s, int size)
+{
+  return fgets(s, size, fp_);
+}
+
+char* BufferedFile::getsn(char* s, int size)
+{
+  char* ptr = fgets(s, size, fp_);
+  if(ptr) {
+    int len = strlen(ptr);
+    if(ptr[len-1] == '\n') {
+      ptr[len-1] = '\0';
+    }
+  }
+  return ptr;
+}
+
+int BufferedFile::close()
+{
+  if(open_) {
+    open_ = false;
+    return fclose(fp_);
+  } else {
+    return 0;
+  }
+}
+
+} // namespace aria2

+ 78 - 0
src/BufferedFile.h

@@ -0,0 +1,78 @@
+/* <!-- copyright */
+/*
+ * aria2 - The high speed download utility
+ *
+ * Copyright (C) 2011 Tatsuhiro Tsujikawa
+ *
+ * This program 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 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * In addition, as a special exception, the copyright holders give
+ * permission to link the code of portions of this program with the
+ * OpenSSL library under certain conditions as described in each
+ * individual source file, and distribute linked combinations
+ * including the two.
+ * You must obey the GNU General Public License in all respects
+ * for all of the code used other than OpenSSL.  If you modify
+ * file(s) with this exception, you may extend this exception to your
+ * version of the file(s), but you are not obligated to do so.  If you
+ * do not wish to do so, delete this exception statement from your
+ * version.  If you delete this exception statement from all source
+ * files in the program, then also delete it here.
+ */
+/* copyright --> */
+#ifndef D_BUFFERED_FILE_H
+#define D_BUFFERED_FILE_H
+
+#include "common.h"
+
+#include <cstdio>
+#include <string>
+
+namespace aria2 {
+
+// This is a wrapper class for fopen/fclose/fread/fwrite/fgets.
+class BufferedFile {
+private:
+  typedef void (BufferedFile::*unspecified_bool_type)() const;
+  void good_state() const {}
+public:
+  BufferedFile(const std::string& filename, const std::string& mode);
+  ~BufferedFile();
+  // Returns true if file is opened and both ferror and feof returns
+  // 0. Otherwise returns false.
+  operator unspecified_bool_type() const;
+  // wrapper for fread. Using 1 for 2nd argument of fread.
+  size_t read(void* ptr, size_t count);
+  // wrapper for fwrite. Using 1 for 2nd argument of fwrite.
+  size_t write(const void* ptr, size_t count);
+  // wrapper for fgets
+  char* gets(char* s, int size);
+  // wrapper for fgets, but trailing '\n' is replaced with '\0'.
+  char* getsn(char* s, int size);
+  // wrapper for fclose
+  int close();
+  // Mode for reading
+  static const std::string READ;
+  // Mode for writing
+  static const std::string WRITE;
+private:
+  FILE* fp_;
+  // true when file has been opened.
+  bool open_;
+};
+
+} // namespace aria2
+
+#endif // D_BUFFERED_FILE_H

+ 2 - 1
src/Makefile.am

@@ -233,7 +233,8 @@ SRCS += XmlRpcRequestParserController.cc XmlRpcRequestParserController.h\
 	XmlRpcRequestParserState.h\
 	XmlRpcRequestParserStateImpl.cc XmlRpcRequestParserStateImpl.h\
 	XmlRpcElements.cc XmlRpcElements.h\
-	XmlRpcRequestProcessor.h
+	XmlRpcRequestProcessor.h\
+	BufferedFile.cc BufferedFile.h
 
 if HAVE_LIBXML2
 SRCS += Xml2XmlRpcRequestProcessor.cc Xml2XmlRpcRequestProcessor.h

+ 58 - 0
test/BufferedFileTest.cc

@@ -0,0 +1,58 @@
+#include "BufferedFile.h"
+
+#include <iostream>
+
+#include <cppunit/extensions/HelperMacros.h>
+
+#include "File.h"
+
+namespace aria2 {
+
+class BufferedFileTest:public CppUnit::TestFixture {
+
+  CPPUNIT_TEST_SUITE(BufferedFileTest);
+  CPPUNIT_TEST(testOpen);
+  CPPUNIT_TEST_SUITE_END();
+public:
+  void testOpen();
+};
+
+
+CPPUNIT_TEST_SUITE_REGISTRATION(BufferedFileTest);
+
+void BufferedFileTest::testOpen()
+{
+  File f(A2_TEST_OUT_DIR"/aria2_BufferedFileTest_testOpen");
+  f.remove();
+  BufferedFile fail(f.getPath(), BufferedFile::READ);
+  CPPUNIT_ASSERT(!fail);
+
+  BufferedFile wr(f.getPath(),  BufferedFile::WRITE);
+  CPPUNIT_ASSERT(wr);
+  std::string msg = "aria2 rules\nalpha\nbravo\ncharlie";
+  wr.write(msg.data(), msg.size());
+  wr.close();
+
+  BufferedFile rd(f.getPath(), BufferedFile::READ);
+  char buf[256];
+  size_t len = rd.read(buf, 11);
+  CPPUNIT_ASSERT_EQUAL((size_t)11, len);
+  buf[len] = '\0';
+  CPPUNIT_ASSERT_EQUAL(std::string("aria2 rules"), std::string(buf));
+
+  CPPUNIT_ASSERT(rd.gets(buf, sizeof(buf)));
+  CPPUNIT_ASSERT_EQUAL(std::string("\n"), std::string(buf));
+
+  CPPUNIT_ASSERT(rd.gets(buf, sizeof(buf)));
+  CPPUNIT_ASSERT_EQUAL(std::string("alpha\n"), std::string(buf));
+
+  CPPUNIT_ASSERT(rd.getsn(buf, sizeof(buf)));
+  CPPUNIT_ASSERT_EQUAL(std::string("bravo"), std::string(buf));
+
+  CPPUNIT_ASSERT(rd.getsn(buf, sizeof(buf)));
+  CPPUNIT_ASSERT_EQUAL(std::string("charlie"), std::string(buf));
+
+  CPPUNIT_ASSERT(!rd);
+}
+
+} // namespace aria2

+ 2 - 1
test/Makefile.am

@@ -79,7 +79,8 @@ aria2c_SOURCES = AllTest.cc\
 	CookieHelperTest.cc\
 	JsonTest.cc\
 	RpcResponseTest.cc\
-	RpcMethodTest.cc
+	RpcMethodTest.cc\
+	BufferedFileTest.cc
 
 if ENABLE_XML_RPC
 aria2c_SOURCES += XmlRpcRequestParserControllerTest.cc\