gdalalgorithm_c.h

/******************************************************************************
 *
 * Project:  GDAL
 * Purpose:  GDALAlgorithm C API
 * 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 GDAL_ALGORITHM_C_INCLUDED
#define GDAL_ALGORITHM_C_INCLUDED
 
#include "cpl_port.h"
#include "cpl_progress.h"
 
#include "gdal.h"
 
/************************************************************************/
/************************************************************************/
/*                         GDAL Algorithm C API                         */
/************************************************************************/
/************************************************************************/
 
CPL_C_START
 
typedef enum
{
    GAAT_BOOLEAN,
    GAAT_STRING,
    GAAT_INTEGER,
    GAAT_REAL,
    GAAT_DATASET,
    GAAT_STRING_LIST,
    GAAT_INTEGER_LIST,
    GAAT_REAL_LIST,
    GAAT_DATASET_LIST,
} GDALAlgorithmArgType;
 
bool CPL_DLL GDALAlgorithmArgTypeIsList(GDALAlgorithmArgType type);
 
const char CPL_DLL *GDALAlgorithmArgTypeName(GDALAlgorithmArgType type);
 
typedef struct GDALArgDatasetValueHS *GDALArgDatasetValueH;
 
typedef struct GDALAlgorithmArgHS *GDALAlgorithmArgH;
 
typedef struct GDALAlgorithmHS *GDALAlgorithmH;
 
typedef struct GDALAlgorithmRegistryHS *GDALAlgorithmRegistryH;
 
/************************************************************************/
/*                      GDALAlgorithmRegistryH API                      */
/************************************************************************/
 
GDALAlgorithmRegistryH CPL_DLL GDALGetGlobalAlgorithmRegistry(void);
 
void CPL_DLL GDALAlgorithmRegistryRelease(GDALAlgorithmRegistryH);
 
char CPL_DLL **GDALAlgorithmRegistryGetAlgNames(GDALAlgorithmRegistryH);
 
GDALAlgorithmH CPL_DLL GDALAlgorithmRegistryInstantiateAlg(
    GDALAlgorithmRegistryH, const char *pszAlgName);
 
GDALAlgorithmH CPL_DLL GDALAlgorithmRegistryInstantiateAlgFromPath(
    GDALAlgorithmRegistryH, const char *const *papszAlgPath);
 
/************************************************************************/
/*                          GDALAlgorithmH API                          */
/************************************************************************/
 
void CPL_DLL GDALAlgorithmRelease(GDALAlgorithmH);
 
const char CPL_DLL *GDALAlgorithmGetName(GDALAlgorithmH);
 
const char CPL_DLL *GDALAlgorithmGetDescription(GDALAlgorithmH);
 
const char CPL_DLL *GDALAlgorithmGetLongDescription(GDALAlgorithmH);
 
const char CPL_DLL *GDALAlgorithmGetHelpFullURL(GDALAlgorithmH);
 
bool CPL_DLL GDALAlgorithmHasSubAlgorithms(GDALAlgorithmH);
 
char CPL_DLL **GDALAlgorithmGetSubAlgorithmNames(GDALAlgorithmH);
 
GDALAlgorithmH CPL_DLL
GDALAlgorithmInstantiateSubAlgorithm(GDALAlgorithmH, const char *pszSubAlgName);
 
bool CPL_DLL GDALAlgorithmParseCommandLineArguments(GDALAlgorithmH,
                                                    CSLConstList papszArgs);
 
char CPL_DLL **GDALAlgorithmGetArgDependencies(GDALAlgorithmH,
                                               const char *pszArgumentName);
 
GDALAlgorithmH CPL_DLL GDALAlgorithmGetActualAlgorithm(GDALAlgorithmH);
 
bool CPL_DLL GDALAlgorithmRun(GDALAlgorithmH, GDALProgressFunc pfnProgress,
                              void *pProgressData);
 
bool CPL_DLL GDALAlgorithmFinalize(GDALAlgorithmH);
 
char CPL_DLL *GDALAlgorithmGetUsageAsJSON(GDALAlgorithmH);
 
char CPL_DLL **GDALAlgorithmGetArgNames(GDALAlgorithmH);
 
GDALAlgorithmArgH CPL_DLL GDALAlgorithmGetArg(GDALAlgorithmH,
                                              const char *pszArgName);
 
GDALAlgorithmArgH CPL_DLL GDALAlgorithmGetArgNonConst(GDALAlgorithmH,
                                                      const char *pszArgName);
 
/************************************************************************/
/*                        GDALAlgorithmArgH API                         */
/************************************************************************/
 
void CPL_DLL GDALAlgorithmArgRelease(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetName(GDALAlgorithmArgH);
 
GDALAlgorithmArgType CPL_DLL GDALAlgorithmArgGetType(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetDescription(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetShortName(GDALAlgorithmArgH);
 
char CPL_DLL **GDALAlgorithmArgGetAliases(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetMetaVar(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetCategory(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgIsPositional(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgIsRequired(GDALAlgorithmArgH);
 
int CPL_DLL GDALAlgorithmArgGetMinCount(GDALAlgorithmArgH);
 
int CPL_DLL GDALAlgorithmArgGetMaxCount(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgGetPackedValuesAllowed(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgGetRepeatedArgAllowed(GDALAlgorithmArgH);
 
char CPL_DLL **GDALAlgorithmArgGetChoices(GDALAlgorithmArgH);
 
char CPL_DLL **GDALAlgorithmArgGetMetadataItem(GDALAlgorithmArgH, const char *);
 
bool CPL_DLL GDALAlgorithmArgIsExplicitlySet(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgHasDefaultValue(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgGetDefaultAsBoolean(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetDefaultAsString(GDALAlgorithmArgH);
 
int CPL_DLL GDALAlgorithmArgGetDefaultAsInteger(GDALAlgorithmArgH);
 
double CPL_DLL GDALAlgorithmArgGetDefaultAsDouble(GDALAlgorithmArgH);
 
char CPL_DLL **GDALAlgorithmArgGetDefaultAsStringList(GDALAlgorithmArgH);
 
const int CPL_DLL *GDALAlgorithmArgGetDefaultAsIntegerList(GDALAlgorithmArgH,
                                                           size_t *pnCount);
 
const double CPL_DLL *GDALAlgorithmArgGetDefaultAsDoubleList(GDALAlgorithmArgH,
                                                             size_t *pnCount);
 
bool CPL_DLL GDALAlgorithmArgIsHidden(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgIsHiddenForCLI(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgIsHiddenForAPI(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgIsAvailableInPipelineStep(GDALAlgorithmArgH);
 
#ifndef DOXYGEN_SKIP
bool CPL_DLL GDALAlgorithmArgIsOnlyForCLI(GDALAlgorithmArgH)
    CPL_WARN_DEPRECATED("Use GDALAlgorithmArgIsHiddenForAPI() instead");
#endif
 
bool CPL_DLL GDALAlgorithmArgIsInput(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgIsOutput(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetMutualExclusionGroup(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetMutualDependencyGroup(GDALAlgorithmArgH);
 
bool CPL_DLL GDALAlgorithmArgGetAsBoolean(GDALAlgorithmArgH);
 
const char CPL_DLL *GDALAlgorithmArgGetAsString(GDALAlgorithmArgH);
 
GDALArgDatasetValueH
    CPL_DLL GDALAlgorithmArgGetAsDatasetValue(GDALAlgorithmArgH);
 
int CPL_DLL GDALAlgorithmArgGetAsInteger(GDALAlgorithmArgH);
 
double CPL_DLL GDALAlgorithmArgGetAsDouble(GDALAlgorithmArgH);
 
char CPL_DLL **GDALAlgorithmArgGetAsStringList(GDALAlgorithmArgH);
 
char CPL_DLL **GDALAlgorithmArgGetDirectDependencies(GDALAlgorithmArgH);
 
const int CPL_DLL *GDALAlgorithmArgGetAsIntegerList(GDALAlgorithmArgH,
                                                    size_t *pnCount);
 
const double CPL_DLL *GDALAlgorithmArgGetAsDoubleList(GDALAlgorithmArgH,
                                                      size_t *pnCount);
 
bool CPL_DLL GDALAlgorithmArgSetAsBoolean(GDALAlgorithmArgH, bool);
 
bool CPL_DLL GDALAlgorithmArgSetAsString(GDALAlgorithmArgH, const char *);
 
bool CPL_DLL GDALAlgorithmArgSetAsDatasetValue(GDALAlgorithmArgH hArg,
                                               GDALArgDatasetValueH value);
 
bool CPL_DLL GDALAlgorithmArgSetDataset(GDALAlgorithmArgH hArg, GDALDatasetH);
 
bool CPL_DLL GDALAlgorithmArgSetDatasets(GDALAlgorithmArgH hArg, size_t nCount,
                                         GDALDatasetH *);
 
bool CPL_DLL GDALAlgorithmArgSetDatasetNames(GDALAlgorithmArgH hArg,
                                             CSLConstList);
 
bool CPL_DLL GDALAlgorithmArgSetAsInteger(GDALAlgorithmArgH, int);
 
bool CPL_DLL GDALAlgorithmArgSetAsDouble(GDALAlgorithmArgH, double);
 
bool CPL_DLL GDALAlgorithmArgSetAsStringList(GDALAlgorithmArgH, CSLConstList);
 
bool CPL_DLL GDALAlgorithmArgSetAsIntegerList(GDALAlgorithmArgH, size_t nCount,
                                              const int *pnValues);
 
bool CPL_DLL GDALAlgorithmArgSetAsDoubleList(GDALAlgorithmArgH, size_t nCount,
                                             const double *pnValues);
 
typedef int GDALArgDatasetType;
 
GDALArgDatasetType CPL_DLL GDALAlgorithmArgGetDatasetType(GDALAlgorithmArgH);
 
#define GADV_NAME (1 << 0)
#define GADV_OBJECT (1 << 1)
 
int CPL_DLL GDALAlgorithmArgGetDatasetInputFlags(GDALAlgorithmArgH);
 
int CPL_DLL GDALAlgorithmArgGetDatasetOutputFlags(GDALAlgorithmArgH);
 
/************************************************************************/
/*                       GDALArgDatasetValueH API                       */
/************************************************************************/
 
GDALArgDatasetValueH CPL_DLL GDALArgDatasetValueCreate(void);
 
void CPL_DLL GDALArgDatasetValueRelease(GDALArgDatasetValueH);
 
const char CPL_DLL *GDALArgDatasetValueGetName(GDALArgDatasetValueH);
 
GDALDatasetH CPL_DLL GDALArgDatasetValueGetDatasetRef(GDALArgDatasetValueH);
 
GDALDatasetH
    CPL_DLL GDALArgDatasetValueGetDatasetIncreaseRefCount(GDALArgDatasetValueH);
 
void CPL_DLL GDALArgDatasetValueSetName(GDALArgDatasetValueH, const char *);
 
void CPL_DLL GDALArgDatasetValueSetDataset(GDALArgDatasetValueH, GDALDatasetH);
 
CPL_C_END
 
#endif  // GDAL_ALGORITHM_C_INCLUDED