Ported DOOR, added RAW mode to esmtool

esm/esm_reader.hpp

@@ -6,6 +6,8 @@
 #include <string.h>
 #include <assert.h>
 #include <vector>
+#include <sstream>
+#include <iomanip>
 
 #include "../mangle/stream/stream.h"
 #include "../mangle/stream/servers/file_stream.h"
@@ -130,7 +132,8 @@ public:
   const std::string getDesc() { return header.desc.toString(); }
   const SaveData &getSaveData() { return saveData; }
   const MasterList &getMasters() { return masters; }
-
+  NAME retSubName() { return subName; }
+  uint32_t getSubSize() { return leftSub; }
 
   /*************************************************************************
    *
@@ -152,8 +155,9 @@ public:
     subName.val = 0;
   }
 
-  /// Load ES file from a new stream. Calls close() automatically.
-  void open(Mangle::Stream::StreamPtr _esm, const std::string &name)
+  /// Raw opening. Opens the file and sets everything up but doesn't
+  /// parse the header.
+  void openRaw(Mangle::Stream::StreamPtr _esm, const std::string &name)
   {
     close();
     esm = _esm;
@@ -167,6 +171,13 @@ public:
     else if(iends(cstr, "Tribunal.esm")) spf = SF_Tribunal;
     else if(iends(cstr, "Bloodmoon.esm")) spf = SF_Bloodmoon;
     else spf = SF_Other;
+  }
+
+  /// Load ES file from a new stream, parses the header. Calls close()
+  /// automatically.
+  void open(Mangle::Stream::StreamPtr _esm, const std::string &name)
+  {
+    openRaw(_esm, name);
 
     if(getRecName() != "TES3")
       fail("Not a valid Morrowind file");
@@ -219,6 +230,12 @@ public:
     open(StreamPtr(new FileStream(file)), file);
   }
 
+  void openRaw(const std::string &file)
+  {
+    using namespace Mangle::Stream;
+    openRaw(StreamPtr(new FileStream(file)), file);
+  }
+
   /*************************************************************************
    *
    *  Medium-level reading shortcuts
@@ -396,6 +413,12 @@ public:
       fail("No more records, getRecName() failed");
     getName(recName);
     leftFile -= 4;
+
+    // Make sure we don't carry over any old cached subrecord
+    // names. This can happen in some cases when we skip parts of a
+    // record.
+    subCached = false;
+
     return recName;
   }
 
@@ -442,6 +465,7 @@ public:
     }
 
   bool hasMoreRecs() { return leftFile > 0; }
+  bool hasMoreSubs() { return leftRec > 0; }
 
 
   /*************************************************************************
@@ -474,15 +498,22 @@ public:
   }
 
   void skip(int bytes) { esm->seek(esm->tell()+bytes); }
+  uint64_t getOffset() { return esm->tell(); }
 
   /// Used for error handling
   void fail(const std::string &msg)
     {
-      std::string err = "ESM Error: " + msg;
-      err += "\n  File: " + filename;
-      err += "\n  Record: " + recName.toString();
-      err += "\n  Subrecord: " + subName.toString();
-      throw str_exception(err);
+      using namespace std;
+
+      stringstream ss;
+
+      ss << "ESM Error: " << msg;
+      ss << "\n  File: " << filename;
+      ss << "\n  Record: " << recName.toString();
+      ss << "\n  Subrecord: " << subName.toString();
+      if(esm != NULL)
+        ss << "\n  Offset: 0x" << hex << esm->tell();
+      throw str_exception(ss.str());
     }
 
 private:

esm/loadbsgn.hpp

@@ -1,5 +1,5 @@
-#ifndef _ESM_SOUN_H
-#define _ESM_SOUN_H
+#ifndef _ESM_BSGN_H
+#define _ESM_BSGN_H
 
 #include "esm_reader.hpp"
 //#include "loadspel.hpp"

esm/loaddoor.hpp

@@ -0,0 +1,19 @@
+#ifndef _ESM_DOOR_H
+#define _ESM_DOOR_H
+
+#include "esm_reader.hpp"
+
+struct Door
+{
+  std::string name, model, script, openSound, closeSound;
+
+  void load(ESMReader &esm)
+  {
+    model = esm.getHNString("MODL");
+    name = esm.getHNOString("FNAM");
+    script = esm.getHNOString("SCRI");
+    openSound = esm.getHNOString("SNAM");
+    closeSound = esm.getHNOString("ANAM");
+  }
+};
+#endif

esm/records.hpp

@@ -4,6 +4,7 @@
 #include "loadarmo.hpp"
 #include "loadbody.hpp"
 #include "loadbsgn.hpp"
+#include "loaddoor.hpp"
 #include "loadsoun.hpp"
 
 // Integer versions of all the record names, used for faster lookup

esm/tests/.gitignore

@@ -3,3 +3,4 @@
 *.ess
 *_test
 esmtool
+*_raw.txt

esm/tests/Makefile

@@ -1,7 +1,10 @@
 all: esmtool
 
-esmtool: esmtool.cpp ../esm_reader.hpp ../records.hpp
-	g++ esmtool.cpp ../../tools/stringops.cpp -o $@
+esmtool: esmtool.cpp ../esm_reader.hpp ../records.hpp esmtool_cmd.c
+	g++ esmtool.cpp ../../tools/stringops.cpp esmtool_cmd.c -o $@
+
+esmtool_cmd.c: esmtool.ggo
+	gengetopt < esmtool.ggo
 
 clean:
 	rm *_test esmtool

esm/tests/esmtool.cpp

@@ -1,21 +1,47 @@
-#include <iostream>
-using namespace std;
-
 #include "../esm_reader.hpp"
 #include "../records.hpp"
 
+#include "esmtool_cmd.h"
+
+#include <iostream>
+using namespace std;
+
+void printRaw(ESMReader &esm);
+
 int main(int argc, char**argv)
 {
-  if(argc != 2)
+  gengetopt_args_info info;
+
+  if(cmdline_parser(argc, argv, &info) != 0)
+    return 1;
+
+  if(info.inputs_num != 1)
     {
-      cout << "Specify an ES file\n";
+      if(info.inputs_num == 0)
+        cout << "ERROR: missing ES file\n\n";
+      else
+        cout << "ERROR: more than one ES file specified\n\n";
+      cmdline_parser_print_help();
       return 1;
     }
 
   ESMReader esm;
-  esm.open(argv[1]);
+  const char* filename = info.inputs[0];
+  cout << "\nFile: " << filename << endl;
+
+  if(info.raw_given)
+    {
+      cout << "RAW file listing:\n";
+
+      esm.openRaw(filename);
+
+      printRaw(esm);
+
+      return 0;
+    }
+
+  esm.open(filename);
 
-  cout << "\nFile: " << argv[1] << endl;
   cout << "Author: " << esm.getAuthor() << endl;
   cout << "Description: " << esm.getDesc() << endl;
   cout << "File format version: " << esm.getFVer() << endl;
@@ -31,7 +57,8 @@ int main(int argc, char**argv)
       NAME n = esm.getRecName();
       cout << "\nRecord: " << n.toString();
       esm.getRecHeader();
-      cout << " '" << esm.getHNString("NAME") << "'\n";
+      string id = esm.getHNOString("NAME");
+      cout << " '" << id << "'\n";
 
       switch(n.val)
         {
@@ -57,10 +84,29 @@ int main(int argc, char**argv)
             break;
           }
         default:
-          cout << "  Skipping\n";
+          //cout << "  Skipping\n";
           esm.skipRecord();
         }
     }
 
   return 0;
 }
+
+void printRaw(ESMReader &esm)
+{
+  while(esm.hasMoreRecs())
+    {
+      NAME n = esm.getRecName();
+      cout << "Record: " << n.toString() << endl;
+      esm.getRecHeader();
+      while(esm.hasMoreSubs())
+        {
+          uint64_t offs = esm.getOffset();
+          esm.getSubName();
+          esm.skipHSub();
+          n = esm.retSubName();
+          cout << "    " << n.toString() << " - " << esm.getSubSize()
+               << " bytes @ 0x" << hex << offs << "\n";
+        }
+    }
+}

esm/tests/esmtool.ggo

@@ -0,0 +1,8 @@
+package "esmtool"
+version "1.0"
+purpose "Inspect and extract from Morrowind ES files (ESM, ESP, ESS)"
+args "--unamed-opts=ES-FILE -F esmtool_cmd -G"
+
+option "raw" r "Show an unformattet list of all records and subrecords" optional
+
+text "\nIf no option is given, the default action is to parse the entire archive and diplay diagnostic information."

esm/tests/esmtool_cmd.h

@@ -0,0 +1,175 @@
+/** @file esmtool_cmd.h
+ *  @brief The header file for the command line option parser
+ *  generated by GNU Gengetopt version 2.22.2
+ *  http://www.gnu.org/software/gengetopt.
+ *  DO NOT modify this file, since it can be overwritten
+ *  @author GNU Gengetopt by Lorenzo Bettini */
+
+#ifndef ESMTOOL_CMD_H
+#define ESMTOOL_CMD_H
+
+/* If we use autoconf.  */
+#ifdef HAVE_CONFIG_H
+#include "config.h"
+#endif
+
+#include <stdio.h> /* for FILE */
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+#ifndef CMDLINE_PARSER_PACKAGE
+/** @brief the program name (used for printing errors) */
+#define CMDLINE_PARSER_PACKAGE "esmtool"
+#endif
+
+#ifndef CMDLINE_PARSER_PACKAGE_NAME
+/** @brief the complete program name (used for help and version) */
+#define CMDLINE_PARSER_PACKAGE_NAME "esmtool"
+#endif
+
+#ifndef CMDLINE_PARSER_VERSION
+/** @brief the program version */
+#define CMDLINE_PARSER_VERSION "1.0"
+#endif
+
+/** @brief Where the command line options are stored */
+struct gengetopt_args_info
+{
+  const char *help_help; /**< @brief Print help and exit help description.  */
+  const char *version_help; /**< @brief Print version and exit help description.  */
+  const char *raw_help; /**< @brief Show an unformattet list of all records and subrecords help description.  */
+  
+  unsigned int help_given ;	/**< @brief Whether help was given.  */
+  unsigned int version_given ;	/**< @brief Whether version was given.  */
+  unsigned int raw_given ;	/**< @brief Whether raw was given.  */
+
+  char **inputs ; /**< @brief unamed options (options without names) */
+  unsigned inputs_num ; /**< @brief unamed options number */
+} ;
+
+/** @brief The additional parameters to pass to parser functions */
+struct cmdline_parser_params
+{
+  int override; /**< @brief whether to override possibly already present options (default 0) */
+  int initialize; /**< @brief whether to initialize the option structure gengetopt_args_info (default 1) */
+  int check_required; /**< @brief whether to check that all required options were provided (default 1) */
+  int check_ambiguity; /**< @brief whether to check for options already specified in the option structure gengetopt_args_info (default 0) */
+  int print_errors; /**< @brief whether getopt_long should print an error message for a bad option (default 1) */
+} ;
+
+/** @brief the purpose string of the program */
+extern const char *gengetopt_args_info_purpose;
+/** @brief the usage string of the program */
+extern const char *gengetopt_args_info_usage;
+/** @brief all the lines making the help output */
+extern const char *gengetopt_args_info_help[];
+
+/**
+ * The command line parser
+ * @param argc the number of command line options
+ * @param argv the command line options
+ * @param args_info the structure where option information will be stored
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int cmdline_parser (int argc, char * const *argv,
+  struct gengetopt_args_info *args_info);
+
+/**
+ * The command line parser (version with additional parameters - deprecated)
+ * @param argc the number of command line options
+ * @param argv the command line options
+ * @param args_info the structure where option information will be stored
+ * @param override whether to override possibly already present options
+ * @param initialize whether to initialize the option structure my_args_info
+ * @param check_required whether to check that all required options were provided
+ * @return 0 if everything went fine, NON 0 if an error took place
+ * @deprecated use cmdline_parser_ext() instead
+ */
+int cmdline_parser2 (int argc, char * const *argv,
+  struct gengetopt_args_info *args_info,
+  int override, int initialize, int check_required);
+
+/**
+ * The command line parser (version with additional parameters)
+ * @param argc the number of command line options
+ * @param argv the command line options
+ * @param args_info the structure where option information will be stored
+ * @param params additional parameters for the parser
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int cmdline_parser_ext (int argc, char * const *argv,
+  struct gengetopt_args_info *args_info,
+  struct cmdline_parser_params *params);
+
+/**
+ * Save the contents of the option struct into an already open FILE stream.
+ * @param outfile the stream where to dump options
+ * @param args_info the option struct to dump
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int cmdline_parser_dump(FILE *outfile,
+  struct gengetopt_args_info *args_info);
+
+/**
+ * Save the contents of the option struct into a (text) file.
+ * This file can be read by the config file parser (if generated by gengetopt)
+ * @param filename the file where to save
+ * @param args_info the option struct to save
+ * @return 0 if everything went fine, NON 0 if an error took place
+ */
+int cmdline_parser_file_save(const char *filename,
+  struct gengetopt_args_info *args_info);
+
+/**
+ * Print the help
+ */
+void cmdline_parser_print_help(void);
+/**
+ * Print the version
+ */
+void cmdline_parser_print_version(void);
+
+/**
+ * Initializes all the fields a cmdline_parser_params structure 
+ * to their default values
+ * @param params the structure to initialize
+ */
+void cmdline_parser_params_init(struct cmdline_parser_params *params);
+
+/**
+ * Allocates dynamically a cmdline_parser_params structure and initializes
+ * all its fields to their default values
+ * @return the created and initialized cmdline_parser_params structure
+ */
+struct cmdline_parser_params *cmdline_parser_params_create(void);
+
+/**
+ * Initializes the passed gengetopt_args_info structure's fields
+ * (also set default values for options that have a default)
+ * @param args_info the structure to initialize
+ */
+void cmdline_parser_init (struct gengetopt_args_info *args_info);
+/**
+ * Deallocates the string fields of the gengetopt_args_info structure
+ * (but does not deallocate the structure itself)
+ * @param args_info the structure to deallocate
+ */
+void cmdline_parser_free (struct gengetopt_args_info *args_info);
+
+/**
+ * Checks that all the required options were specified
+ * @param args_info the structure to check
+ * @param prog_name the name of the program that will be used to print
+ *   possible errors
+ * @return
+ */
+int cmdline_parser_required (struct gengetopt_args_info *args_info,
+  const char *prog_name);
+
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+#endif /* ESMTOOL_CMD_H */

old_d_version/esm/loaddoor.d

@@ -1,50 +0,0 @@
-/*
-  OpenMW - The completely unofficial reimplementation of Morrowind
-  Copyright (C) 2008  Nicolay Korslund
-  Email: < korslund@gmail.com >
-  WWW: http://openmw.snaptoad.com/
-
-  This file (loaddoor.d) is part of the OpenMW package.
-
-  OpenMW is distributed as free software: you can redistribute it
-  and/or modify it under the terms of the GNU General Public License
-  version 3, as published by the Free Software Foundation.
-
-  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
-  version 3 along with this program. If not, see
-  http://www.gnu.org/licenses/ .
-
- */
-
-module esm.loaddoor;
-import esm.imports;
-
-/*
- * Doors
- */
-
-struct Door
-{
-  MeshIndex model;
-  Script *script;
-  Sound* openSound, closeSound;
-
-  mixin LoadT!();
-
-  void load()
-  {with(esFile){
-    model = getMesh();
-    name = getHNOString("FNAM");
-    script = getHNOPtr!(Script)("SCRI", scripts);
-    openSound = getHNOPtr!(Sound)("SNAM", sounds);
-    closeSound = getHNOPtr!(Sound)("ANAM", sounds);
-
-    makeProto();
-  }}
-}
-ListID!(Door) doors; // Break on through