LOFImportPlugin Class Reference

An ImportPlugin for LOF data. More...

Inheritance diagram for LOFImportPlugin:

Collaboration diagram for LOFImportPlugin:

Public Member Functions
	LOFImportPlugin ()
	~LOFImportPlugin ()
wxString	GetPluginStringID () override
TranslatableString	GetPluginFormatDescription () override
std::unique_ptr< ImportFileHandle >	Open (const FilePath &Filename, AudacityProject *pProject) override
Public Member Functions inherited from ImportPlugin
virtual wxString	GetPluginStringID ()=0
virtual TranslatableString	GetPluginFormatDescription ()=0
virtual FileExtensions	GetSupportedExtensions ()
virtual TranslatableString	FailureHint () const
	User visible message suggesting what to do when a file type isn't recognized; default empty string. More...
bool	SupportsExtension (const FileExtension &extension)
virtual std::unique_ptr< ImportFileHandle >	Open (const FilePath &Filename, AudacityProject *)=0
virtual	~ImportPlugin ()

Additional Inherited Members
Protected Member Functions inherited from ImportPlugin
	ImportPlugin (FileExtensions supportedExtensions)
Protected Attributes inherited from ImportPlugin
const FileExtensions	mExtensions

Detailed Description

An ImportPlugin for LOF data.

Definition at line 96 of file ImportLOF.cpp.

Constructor & Destructor Documentation

LOFImportPlugin()

LOFImportPlugin::LOFImportPlugin ( )

inline

Definition at line 99 of file ImportLOF.cpp.

   :  ImportPlugin( FileExtensions( exts.begin(), exts.end() ) )
   {
   }

~LOFImportPlugin()

LOFImportPlugin::~LOFImportPlugin ( )

inline

Definition at line 104 of file ImportLOF.cpp.

{ }

Member Function Documentation

GetPluginFormatDescription()

TranslatableString LOFImportPlugin::GetPluginFormatDescription ( )

overridevirtual

Implements ImportPlugin.

Definition at line 174 of file ImportLOF.cpp.

{
    return DESC;
}

References DESC.

GetPluginStringID()

wxString LOFImportPlugin::GetPluginStringID ( )

inlineoverridevirtual

Implements ImportPlugin.

Definition at line 106 of file ImportLOF.cpp.

{ return wxT("lof"); }

References wxT().

Here is the call graph for this function:

Open()

std::unique_ptr< ImportFileHandle > LOFImportPlugin::Open ( const FilePath &  Filename, AudacityProject *  pProject  )

overridevirtual

Implements ImportPlugin.

Definition at line 179 of file ImportLOF.cpp.

{
   // Check if it is a text file.
   {
      wxFile binaryFile;
      if (!binaryFile.Open(filename))
         return nullptr; // File not found
 
      char buf[BINARY_FILE_CHECK_BUFFER_SIZE];
      int count = binaryFile.Read(buf, BINARY_FILE_CHECK_BUFFER_SIZE);
 
      bool isTextFile = false;
      const std::string lofToken("file");
 
      // At least we should get a size more than: <token> + <space> + <filename>.
      if (count > (lofToken.length() + sizeof(' ') + 1))
      {
          // Audacity can import list from LOF only with BOM or ASCII,
          // each other text (like unicode without BOM, bin, etc) can't be recognized.
 
          // UTF-16 BOM checker.
          auto IsUtf16_BE = [](const char* str) -> bool
          {
              return str[0] == static_cast<char>(0xFE) && str[1] == static_cast<char>(0xFF);
          };
          auto IsUtf16_LE = [](const char* str) -> bool
          {
              return str[0] == static_cast<char>(0xFF) && str[1] == static_cast<char>(0xFE);
          };
 
          // UTF-32 BOM checker.
          auto IsUtf32_BE = [](const char* str) -> bool
          {
              return str[0] == static_cast<char>(0x00) &&
                     str[1] == static_cast<char>(0x00) &&
                     str[2] == static_cast<char>(0xFE) &&
                     str[3] == static_cast<char>(0xFF);
          };
          auto IsUtf32_LE = [](const char* str) -> bool
          {
              return str[0] == static_cast<char>(0xFF) &&
                     str[1] == static_cast<char>(0xFE) &&
                     str[2] == static_cast<char>(0x00) &&
                     str[3] == static_cast<char>(0x00);
          };
 
          // Is unicode text file.
          if (IsUtf16_BE(buf) || IsUtf16_LE(buf) || IsUtf32_BE(buf) || IsUtf32_LE(buf))
          {
              isTextFile = true;
          }
          // Try parse as ASCII and UTF-8 text as ASCII too.
          else
          {
              buf[sizeof(buf) - 1] = '\0';
 
              std::string importedText(buf);
 
              if (importedText.find(lofToken) != std::string::npos)
                  isTextFile = true;
          }
      }
 
      if (!isTextFile)
      {
          binaryFile.Close();
          return nullptr;
      }
   }
 
   // Now open the file again as text file
   auto file = std::make_unique<wxTextFile>(filename);
   file->Open();
 
   if (!file->IsOpened())
      return nullptr;
 
   return std::make_unique<LOFImportFileHandle>(
      pProject, filename, std::move(file));
}

References BINARY_FILE_CHECK_BUFFER_SIZE, Tuple::detail::npos(), and str.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• ImportLOF.cpp