#!/usr/bin/python
#
# Copyright 2017 Google Inc. 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.
"""Common command line parser for all Starboard tools.

Arguments can be added to the parser returned from CreateParser() on a
per-tool basis.
"""

import argparse


def CreateParser():
  """Returns an argparse.ArgumentParser object set up for Starboard tools."""
  arg_parser = argparse.ArgumentParser(
      description="Runs application/tool executables.")
  arg_parser.add_argument(
      "-p",
      "--platform",
      help="Device platform, eg 'linux-x64x11'.")
  arg_parser.add_argument(
      "-c",
      "--config",
      choices=["debug", "devel", "qa", "gold"],
      help="Build config (eg, 'qa' or 'devel')")
  arg_parser.add_argument(
      "-d",
      "--device_id",
      help="Devkit or IP address for the target device.")
  arg_parser.add_argument(
      "-t",
      "--target_name",
      help="Name of executable target.")
  arg_parser.add_argument(
      "--target_params",
      help="Command line arguments to pass to the executable."
           " Because different executables could have differing command"
           " line syntax, list all arguments exactly as you would to the"
           " executable between a set of double quotation marks.")
  arg_parser.add_argument(
      "-o",
      "--out_directory",
      help="Directory containing tool binaries or their components."
           " Automatically derived if absent.")
  return arg_parser