src/developer/debug/zxdb/console/commands/verb_new.cc

// Copyright 2019 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#include "src/developer/debug/zxdb/console/commands/verb_new.h"

#include "src/developer/debug/zxdb/client/filter.h"
#include "src/developer/debug/zxdb/client/session.h"
#include "src/developer/debug/zxdb/console/command_utils.h"
#include "src/developer/debug/zxdb/console/console.h"
#include "src/developer/debug/zxdb/console/console_context.h"
#include "src/developer/debug/zxdb/console/format_filter.h"
#include "src/developer/debug/zxdb/console/format_job.h"
#include "src/developer/debug/zxdb/console/format_target.h"
#include "src/developer/debug/zxdb/console/verbs.h"

namespace zxdb {

namespace {

const char kNewShortHelp[] = "new: Create a new debugger object.";
const char kNewHelp[] =
    R"(<object-type> [ <reference-object-id> ] new

  Creates a new object of type <object-type>.

  The settings from the current object will be cloned. If an explicit object
  index is specified ("process 2 new"), the new one will clone the given one.
  The new object will be the active one of that type.

filter new

  A filter looks for process launches matching a pattern and automatically
  attaches to them. Most often, filters are created with the "attach <filter>"
  command. See "help filter" and "help attach" for more.

  [zxdb] filter new
  Filter 2  FIXME

job new

  A job context holds settings (filters, etc.) and possibly a running job. The
  new context will have no associated job and can then be run or attached.
  Attach a job context with a job on the target system with "attach-job <koid>".

    [zxdb] job new
    Job 2 [Not attached]
    [zxdb] job 2 attach-job 1960
    Job 2 [Attached] koid=1960

process new

  A process context holds settings (binary name, command line arguments, etc.)
  and possibly a running process. The new context will have no associated
  process and can then be run or attached.

    [zxdb] process new
    Process 2 [Not running]
    [zxdb] attach 22860
    Attached Process 2 [Running] koid=22860 foobar.cmx
)";

Err RunVerbNew(ConsoleContext* context, const Command& cmd) {
  // Require exactly one noun to be specified for the type of object.
  if (cmd.nouns().size() != 1u || !cmd.args().empty()) {
    return Err(
        "Use \"<object-type> new\" to create a new object of <object-type>.\n"
        "For example, \"process new\".");
  }

  Console* console = Console::get();

  switch (cmd.nouns().begin()->first) {
    case Noun::kFilter: {
      Filter* new_filter = context->session()->system().CreateNewFilter();
      if (cmd.filter()) {
        // Clone existing filter's settings.
        new_filter->SetJob(cmd.filter()->job());
        new_filter->SetPattern(cmd.filter()->pattern());
      }
      context->SetActiveFilter(new_filter);
      console->Output(FormatFilter(context, new_filter));
      break;
    }
    case Noun::kJob: {
      Job* new_job = context->session()->system().CreateNewJob();
      context->SetActiveJob(new_job);
      console->Output(FormatJob(context, new_job));
      break;
    }
    case Noun::kProcess: {
      Target* new_target = context->session()->system().CreateNewTarget(cmd.target());
      context->SetActiveTarget(new_target);
      console->Output(FormatTarget(context, new_target));
      break;
    }
    case Noun::kBreakpoint: {
      // Creates a disabled-by-default breakpoint with no settings. This isn't very useful but
      // we do this for symmetry.
      Breakpoint* new_breakpoint = context->session()->system().CreateNewBreakpoint();
      context->SetActiveBreakpoint(new_breakpoint);
      console->Output(FormatBreakpoint(context, new_breakpoint, false));
      break;
    }
    default: {
      std::string noun_name = GetNouns().find(cmd.nouns().begin()->first)->second.aliases[0];
      return Err("The \"new\" command is not supported for \"%s\" objects.", noun_name.c_str());
    }
  }

  return Err();
}

}  // namespace

VerbRecord GetNewVerbRecord() {
  return VerbRecord(&RunVerbNew, {"new"}, kNewShortHelp, kNewHelp, CommandGroup::kGeneral);
}

}  // namespace zxdb