File: guest_os_terminal_provider.h

package info (click to toggle)
chromium 139.0.7258.138-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,120,676 kB
  • sloc: cpp: 35,100,869; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (60 lines) | stat: -rw-r--r-- 2,457 bytes parent folder | download | duplicates (7)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_ASH_GUEST_OS_PUBLIC_GUEST_OS_TERMINAL_PROVIDER_H_
#define CHROME_BROWSER_ASH_GUEST_OS_PUBLIC_GUEST_OS_TERMINAL_PROVIDER_H_

#include <string>
#include "chrome/browser/ash/guest_os/guest_id.h"
#include "chrome/browser/extensions/api/terminal/startup_status.h"
#include "storage/browser/file_system/file_system_url.h"

namespace guest_os {

class GuestOsTerminalProvider {
 public:
  GuestOsTerminalProvider();
  virtual ~GuestOsTerminalProvider();

  GuestOsTerminalProvider(const GuestOsTerminalProvider&) = delete;
  GuestOsTerminalProvider& operator=(const GuestOsTerminalProvider&) = delete;

  // Human-friendly localised display label.
  virtual std::string Label() = 0;

  // The id of the guest this provider is for.
  virtual guest_os::GuestId GuestId() = 0;

  // Checks if recovery is required before being able to launch. If so, launches
  // the recovery flow (e.g. shows a dialog) and returns true, otherwise returns
  // false.
  virtual bool RecoveryRequired(int64_t display_id) = 0;

  // Returns false if the terminal should show this entry as being disabled by
  // the user's IT administrator, otherwise return true.
  virtual bool AllowedByPolicy() = 0;

  // Sets up `url` to be the initial working directory of a terminal session,
  // returning the path inside the guest.
  virtual std::string PrepareCwd(storage::FileSystemURL path) = 0;

  // Creates a StartupStatus which will send progress messages to the terminal
  // via the provided printer. Must pass this status to EnsureRunning.
  virtual std::unique_ptr<extensions::StartupStatus> CreateStartupStatus(
      std::unique_ptr<extensions::StartupStatusPrinter> printer) = 0;

  // Ensure the guest is running and ready for vsh connections. Calls `callback`
  // once done, setting `success` appropriately and on failure will stick a
  // human-readable error reason in `failure_reason`. Will use `startup_status`
  // to emit progress messages, this `startup_status` must be the same one
  // created by CreateStartupStatus.
  virtual void EnsureRunning(
      extensions::StartupStatus* startup_status,
      base::OnceCallback<void(bool success, std::string failure_reason)>
          callback) = 0;
};

}  // namespace guest_os

#endif  // CHROME_BROWSER_ASH_GUEST_OS_PUBLIC_GUEST_OS_TERMINAL_PROVIDER_H_