dokanc.h

/*
  Dokan : user-mode file system library for Windows

  Copyright (C) 2020 - 2023 Google, Inc.
  Copyright (C) 2015 - 2019 Adrien J. <liryna.stark@gmail.com> and Maxime C. <maxime@islog.com>
  Copyright (C) 2007 - 2011 Hiroki Asakawa <info@dokan-dev.net>

  http://dokan-dev.github.io

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser 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 Lesser General Public License along
with this program. If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef DOKANC_H_
#define DOKANC_H_

#include "dokan.h"
#include <malloc.h>

#ifdef __cplusplus
extern "C" {
#endif

#define DOKAN_GLOBAL_DEVICE_NAME L"\\\\.\\Dokan_" DOKAN_MAJOR_API_VERSION

#define DOKAN_DRIVER_SERVICE L"Dokan" DOKAN_MAJOR_API_VERSION

#define DOKAN_SERVICE_START 1
#define DOKAN_SERVICE_STOP 2
#define DOKAN_SERVICE_DELETE 3

// DokanOptions->DebugMode is ON?
extern BOOL g_DebugMode;

// DokanOptions->UseStdErr is ON?
extern BOOL g_UseStdErr;

#if defined(_MSC_VER) || (defined(__GNUC__) && !defined(__CYGWIN__))

static VOID DokanDbgPrint(LPCSTR format, ...) {
  const char *outputString = format; // fallback
  char *buffer = NULL;
  int length;
  va_list argp;

  va_start(argp, format);
  length = _vscprintf(format, argp) + 1;
  if ((length - 1) != -1) {
    buffer = (char *)_malloca(length * sizeof(char));
  }
  if (buffer && vsprintf_s(buffer, length, format, argp) != -1) {
    outputString = buffer;
  }
  if (g_UseStdErr)
    fputs(outputString, stderr);
  else
    OutputDebugStringA(outputString);
  if (buffer)
    _freea(buffer);
  va_end(argp);
  if (g_UseStdErr)
    fflush(stderr);
}

static VOID DokanDbgPrintW(LPCWSTR format, ...) {
  const WCHAR *outputString = format; // fallback
  WCHAR *buffer = NULL;
  int length;
  va_list argp;

  va_start(argp, format);
  length = _vscwprintf(format, argp) + 1;
  if ((length - 1) != -1) {
    buffer = (WCHAR *)_malloca(length * sizeof(WCHAR));
  }
  if (buffer && vswprintf_s(buffer, length, format, argp) != -1) {
    outputString = buffer;
  }
  if (g_UseStdErr)
    fputws(outputString, stderr);
  else
    OutputDebugStringW(outputString);
  if (buffer)
    _freea(buffer);
  va_end(argp);
}

#if defined(_MSC_VER)

#define DbgPrint(format, ...)                                                  \
  do {                                                                         \
    if (g_DebugMode) {                                                         \
      DokanDbgPrint(format, __VA_ARGS__);                                      \
    }                                                                          \
  }                                                                            \
  __pragma(warning(push)) __pragma(warning(disable : 4127)) while (0)          \
      __pragma(warning(pop))

#define DbgPrintW(format, ...)                                                 \
  do {                                                                         \
    if (g_DebugMode) {                                                         \
      DokanDbgPrintW(format, __VA_ARGS__);                                     \
    }                                                                          \
  }                                                                            \
  __pragma(warning(push)) __pragma(warning(disable : 4127)) while (0)          \
      __pragma(warning(pop))

#endif // defined(_MSC_VER)

#if defined(__GNUC__)

#define DbgPrint(format, ...)                                                  \
  do {                                                                         \
    if (g_DebugMode) {                                                         \
      DokanDbgPrint(format, ##__VA_ARGS__);                                    \
    }                                                                          \
  } while (0)

#define DbgPrintW(format, ...)                                                 \
  do {                                                                         \
    if (g_DebugMode) {                                                         \
      DokanDbgPrintW(format, ##__VA_ARGS__);                                   \
    }                                                                          \
  } while (0)

#endif // defined(__GNUC__)

#endif // defined(_MSC_VER) || (defined(__GNUC__) && !defined(__CYGWIN__))

#define NT_SUCCESS(Status) (((NTSTATUS)(Status)) >= 0)

VOID DOKANAPI DokanUseStdErr(BOOL Status);

VOID DOKANAPI DokanDebugMode(BOOL Status);

BOOL DOKANAPI DokanServiceInstall(LPCWSTR ServiceName, DWORD ServiceType,
                                  LPCWSTR ServiceFullPath);

BOOL DOKANAPI DokanServiceDelete(LPCWSTR ServiceName);

BOOL DOKANAPI DokanNetworkProviderInstall();

BOOL DOKANAPI DokanNetworkProviderUninstall();

BOOL DOKANAPI DokanSetDebugMode(ULONG Mode);

BOOL DOKANAPI DokanMountPointsCleanUp();

#ifdef __cplusplus
}
#endif

#endif // DOKANC_H_