gdalalg_vsi_list.h

/******************************************************************************
 *
 * Project:  GDAL
 * Purpose:  gdal "vsi list" subcommand
 * Author:   Even Rouault <even dot rouault at spatialys.com>
 *
 ******************************************************************************
 * Copyright (c) 2025, Even Rouault <even dot rouault at spatialys.com>
 *
 * SPDX-License-Identifier: MIT
 ****************************************************************************/
 
#ifndef GDALALG_VSI_LIST_INCLUDED
#define GDALALG_VSI_LIST_INCLUDED
 
#include "gdalalgorithm.h"
 
#include "cpl_json_streaming_writer.h"

 
/************************************************************************/
/*                          GDALVSIListAlgorithm                        */
/************************************************************************/
 
struct VSIDIREntry;
 
class GDALVSIListAlgorithm final : public GDALAlgorithm
{
  public:
    static constexpr const char *NAME = "list";
    static constexpr const char *DESCRIPTION =
        "List files of one of the GDAL Virtual System Interface (VSI).";
    static constexpr const char *HELP_URL = "/programs/gdal_vsi_list.html";
 
    static std::vector<std::string> GetAliasesStatic()
    {
        return {"ls"};
    }
 
    GDALVSIListAlgorithm();
 
  private:
    CPLJSonStreamingWriter m_oWriter;
    std::string m_filename{};
    std::string m_format{};
    std::string m_output{};
    int m_depth = -1;
    bool m_stdout = false;
    bool m_longListing = false;
    bool m_recursive = false;
    bool m_JSONAsTree = false;
    bool m_absolutePath = false;
 
    std::vector<std::string> m_stackNames{};
 
    bool RunImpl(GDALProgressFunc, void *) override;
    void Print(const char *str);
    void PrintEntry(const VSIDIREntry *entry);
    static void JSONPrint(const char *pszTxt, void *pUserData);
};

 
#endif