file_item.h

/*
 * Copyright © 2022-2023 Synthstrom Audible Limited
 *
 * This file is part of The Synthstrom Audible Deluge Firmware.
 *
 * The Synthstrom Audible Deluge Firmware 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.
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "storage/storage_manager.h"
#include "util/d_string.h"
#include <cstdint>
 
class FileItem {
public:
    FileItem() = default;
    Error setupWithInstrument(Instrument* newInstrument, bool hibernating);
    Error getFilenameWithExtension(String* filenameWithExtension);
    Error getFilenameWithoutExtension(String* filenameWithoutExtension);
    Error getDisplayNameWithoutExtension(String* displayNameWithoutExtension);
 
    char const* displayName; // Usually points to filePointer.get(), but for "numeric" files, will cut off the prefix,
                             // e.g. "SONG". And I think this always includes the file extension...
 
    String filename; // May or may not include file extension. (Or actually I think it always does now...)
    FilePointer filePointer{.sclust = 0, .objsize = 0};
    Instrument* instrument = nullptr;
    bool maybeExistsOnCard{true}; // only false when made through setupWithInstrument through an unsaved instrument
    bool isFolder;
    bool instrumentAlreadyInSong = false; // Only valid if instrument is set to something.
    bool filenameIncludesExtension = true;
};