crashpad/tools/tool_support.h
Mark Mentovai 6a5695967f Introduce the crashpad_http_upload tool
crashpad_http_upload sends HTTP POST multipart/form-data requests and
receives responses in exactly the same manner that crashpad_handler does
for crash report uploads, but separates it out for more general testing
and debugging.

Change-Id: I5c5919f9b1dc1e6be1e43b15a35b31f51add8a46
2017-03-03 15:11:50 -05:00

94 lines
3.2 KiB
C++
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Copyright 2014 The Crashpad Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#ifndef CRASHPAD_TOOLS_TOOL_SUPPORT_H_
#define CRASHPAD_TOOLS_TOOL_SUPPORT_H_
#include <string>
#include "base/files/file_path.h"
#include "base/macros.h"
#include "base/strings/string_piece.h"
#include "build/build_config.h"
namespace crashpad {
//! \brief Common functions used by command line tools.
class ToolSupport {
public:
//! \brief Handles `--version`.
//!
//! \param[in] me The tools name, the basename of `argv[0]`.
static void Version(const base::FilePath& me);
//! \brief Prints the footer for `--help`.
//!
//! \param[in] me The tools name, the basename of `argv[0]`.
static void UsageTail(const base::FilePath& me);
//! \brief Suggests using `--help` when a command line tool cant make sense
//! of its arguments.
//!
//! \param[in] me The tools name, the basename of `argv[0]`.
//! \param[in] hint A hint to display before the suggestion to try `--help`.
//! Optional, may be `nullptr`, in which case no hint will be presented.
static void UsageHint(const base::FilePath& me, const char* hint);
#if defined(OS_POSIX) || DOXYGEN
//! \copydoc Version
static void Version(const std::string& me);
//! \copydoc UsageTail
static void UsageTail(const std::string& me);
//! \copydoc UsageHint
static void UsageHint(const std::string& me, const char* hint);
#endif // OS_POSIX
#if defined(OS_WIN) || DOXYGEN
//! \brief Converts \a argv `wchar_t` UTF-16 to UTF-8, and passes onwards to a
//! UTF-8 entry point.
//!
//! \return The return value of \a entry.
static int Wmain(int argc, wchar_t* argv[], int (*entry)(int, char*[]));
#endif // OS_WIN
//! \brief Converts a command line argument to the string type suitable for
//! base::FilePath.
//!
//! On POSIX, this is a no-op. On Windows, assumes that Wmain() was used, and
//! the input argument was converted from UTF-16 in a `wchar_t*` to UTF-8 in a
//! `char*`. This undoes that transformation.
//!
//! \sa Wmain()
//! \sa FilePathToCommandLineArgument()
static base::FilePath::StringType CommandLineArgumentToFilePathStringType(
const base::StringPiece& arg);
//! \brief Converts a base::FilePath to a command line argument.
//!
//! On POSIX, this is a no-op. On Windows, this undoes the transformation done
//! by CommandLineArgumentToFilePathStringType() in the same manner as
//! Wmain().
static std::string FilePathToCommandLineArgument(
const base::FilePath& file_path);
private:
DISALLOW_IMPLICIT_CONSTRUCTORS(ToolSupport);
};
} // namespace crashpad
#endif // CRASHPAD_TOOLS_TOOL_SUPPORT_H_