savefileiterator.h

Go to the documentation of this file.

/*
  * Copyright 2019 Twilight
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *   http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
*/
#pragma once
#include <pse-common/types.h>
#include <QVector>
#include "savefile_autoport.h"
 
// To prevent cross-include and thus errors
class SaveFile;
class SaveFileToolset;

class SAVEFILE_AUTOPORT SaveFileIterator
{
public:
  SaveFileIterator(SaveFile* saveFile);

  SaveFileIterator* offsetTo(var16 val);
  SaveFileIterator* offsetBy(var16 val);
  SaveFileIterator* skipPadding(var16 val); 
 
  SaveFileIterator* inc(); 
  SaveFileIterator* dec(); 
 
  SaveFile* file();         
  SaveFileToolset* toolset(); 

  SaveFileIterator* push();
  SaveFileIterator* pop();
 
  // Here are all the specialized functions that auto-use the offset and
  // auto-increment the offset making things much easier

  QVector<var8> getRange(var16 size, var16 padding = 0, bool reverse = false);
  void copyRange(
      var16 size, QVector<var8> data, var16 padding = 0, bool reverse = false);
  QString getStr(var16 size, var8 maxLen, var16 padding = 0);   
  void setStr(var16 size, var8 maxLen, QString str, var16 padding = 0); 
  QString getHex(var16 size, var16 padding = 0, bool reverse = false);  
  void setHex(var16 size, QString hex, var16 padding = 0, bool reverse = false); 
  var32 getBCD(var8 size, var16 padding = 0);                  
  void setBCD(var8 size, var32 val, var16 padding = 0);        
  bool getBit(var8 size, var8 bit, bool reverse = false);      
  void setBit(
      var8 size, var8 bit, bool value, bool reverse = false);  
  var16 getWord(var16 padding = 0, bool reverse = false);      
  void setWord(var16 val, var16 padding = 0, bool reverse = false); 
  var8 getByte(var16 padding = 0);                             
  void setByte(var8 val, var16 padding = 0);                   
  QVector<bool> getBitField(var16 size, var16 padding = 0);    
  void setBitField(var16 size, QVector<bool> src, var16 padding = 0); 

  var16 offset = 0x0000;
 
protected:
  QVector<var16> state;
 
  SaveFile* saveFile = nullptr; 
};