/*
Copyright (C) 2012 Sebastian Herbord. All rights reserved.

This file is part of Mod Organizer.

Mod Organizer 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 3 of the License, or
(at your option) any later version.

Mod Organizer 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 Mod Organizer.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef SKYRIMINFO_H
#define SKYRIMINFO_H


#include "gameinfo.h"

namespace MOShared {


class SkyrimInfo : public GameInfo
{

  friend class GameInfo;

public:

  virtual ~SkyrimInfo() {}

  virtual unsigned long getBSAVersion();

  static std::wstring getRegPathStatic();
  virtual std::wstring getRegPath() { return SkyrimInfo::getRegPathStatic(); }
  virtual std::wstring getBinaryName() { return L"TESV.exe"; }

  virtual GameInfo::Type getType() { return TYPE_SKYRIM; }

  virtual std::wstring getGameName() const { return L"Skyrim"; }
  virtual std::wstring getGameShortName() const { return L"Skyrim"; }

  virtual LoadOrderMechanism getLoadOrderMechanism() const;

  virtual bool requiresBSAInvalidation() const { return true; }
//  virtual bool requiresSteam() const { return true; }

  virtual std::wstring getInvalidationBSA();

  virtual bool isInvalidationBSA(const std::wstring &bsaName);

  // full path to this games "My Games"-directory
  virtual std::wstring getDocumentsDir();

  virtual std::wstring getSaveGameDir();

  virtual std::vector<std::wstring> getPrimaryPlugins();

  virtual std::vector<std::wstring> getVanillaBSAs();

  // file name of this games ini (no path)
  virtual std::vector<std::wstring> getIniFileNames();

  virtual std::wstring getSaveGameExtension();
  virtual std::wstring getReferenceDataFile();
  virtual std::wstring getOMODExt();

  virtual std::wstring getSteamAPPId();

  virtual std::wstring getSEName();

  virtual std::wstring getNexusPage();

  static std::wstring getNexusInfoUrlStatic();
  virtual std::wstring getNexusInfoUrl() { return SkyrimInfo::getNexusInfoUrlStatic(); }
  static int getNexusModIDStatic();
  virtual int getNexusModID() { return SkyrimInfo::getNexusModIDStatic(); }

  virtual void createProfile(const std::wstring &directory, bool useDefaults);
  virtual void repairProfile(const std::wstring &directory);

  virtual bool rerouteToProfile(const wchar_t *fileName, const wchar_t *fullPath);

  // get a list of executables (game binary and known-to-work 3rd party tools). All of these are relative to
  // the game directory
  virtual std::vector<ExecutableInfo> getExecutables();

  virtual std::wstring archiveListKey() { return L"SResourceArchiveList"; }

private:

  SkyrimInfo(const std::wstring &omoDirectory, const std::wstring &gameDirectory);

  static bool identifyGame(const std::wstring &searchPath);

private:

  std::wstring m_AppData;

};

} // namespace MOShared

#endif // SKYRIMINFO_H