summaryrefslogtreecommitdiff
path: root/java/com/android/dialer/commandline/Arguments.java
blob: 84ed0e4228a05ae7b24ff77624923c7a54fb8b4f (plain)
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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
/*
 * Copyright (C) 2018 The Android Open Source Project
 *
 * 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
 */

package com.android.dialer.commandline;

import android.support.annotation.Nullable;
import com.android.dialer.commandline.Command.IllegalCommandLineArgumentException;
import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterators;
import com.google.common.collect.PeekingIterator;
import com.google.common.collect.UnmodifiableIterator;

/**
 * Parses command line arguments into optional flags (--foo, --key=value, --key value) and required
 * positionals (which must be passed in order). Flags must start with "--" and are always before
 * positionals. If flags are used "--" must be placed before positionals.
 *
 * <p>--flag will be interpreted as --flag=true, and --noflag as --flag=false
 *
 * <p>Grammar:<br>
 * dialer-cmd.py <cmd> <args><br>
 * <args> = (<flags> -- <positionals>) | <positionals><br>
 * <flags> = "no"?<name>(<separator><value>)?<br>
 * <separator> = " " | "="
 */
@AutoValue
public abstract class Arguments {

  public static final Arguments EMPTY =
      new AutoValue_Arguments(ImmutableMap.of(), ImmutableList.of());

  public abstract ImmutableMap<String, String> getFlags();

  public abstract ImmutableList<String> getPositionals();

  /**
   * Return the positional at {@code position}. Throw {@link IllegalCommandLineArgumentException} if
   * it is absent and reports to the user {@code name} is expected.
   */
  public String expectPositional(int position, String name)
      throws IllegalCommandLineArgumentException {
    if (getPositionals().size() <= position) {
      throw new IllegalCommandLineArgumentException(name + " expected");
    }
    return getPositionals().get(position);
  }

  public Boolean getBoolean(String flag, boolean defaultValue)
      throws IllegalCommandLineArgumentException {
    if (!getFlags().containsKey(flag)) {
      return defaultValue;
    }
    switch (getFlags().get(flag)) {
      case "true":
        return true;
      case "false":
        return false;
      default:
        throw new IllegalCommandLineArgumentException("boolean value expected for " + flag);
    }
  }

  public static Arguments parse(@Nullable String[] rawArguments)
      throws IllegalCommandLineArgumentException {
    if (rawArguments == null) {
      return EMPTY;
    }
    return parse(Iterators.forArray(rawArguments));
  }

  public static Arguments parse(Iterable<String> rawArguments)
      throws IllegalCommandLineArgumentException {
    return parse(Iterators.unmodifiableIterator(rawArguments.iterator()));
  }

  public static Arguments parse(UnmodifiableIterator<String> iterator)
      throws IllegalCommandLineArgumentException {
    PeekingIterator<String> peekingIterator = Iterators.peekingIterator(iterator);
    ImmutableMap<String, String> flags = parseFlags(peekingIterator);
    ImmutableList<String> positionals = parsePositionals(peekingIterator);

    return new AutoValue_Arguments(flags, positionals);
  }

  private static ImmutableMap<String, String> parseFlags(PeekingIterator<String> iterator)
      throws IllegalCommandLineArgumentException {
    ImmutableMap.Builder<String, String> flags = ImmutableMap.builder();
    if (!iterator.hasNext()) {
      return flags.build();
    }
    if (!iterator.peek().startsWith("--")) {
      return flags.build();
    }

    while (iterator.hasNext()) {
      String peek = iterator.peek();
      if (peek.equals("--")) {
        iterator.next();
        return flags.build();
      }
      if (peek.startsWith("--")) {
        String key = iterator.next().substring(2);
        String value;
        if (iterator.hasNext() && !iterator.peek().startsWith("--")) {
          value = iterator.next();
        } else if (key.contains("=")) {
          String[] entry = key.split("=", 2);
          key = entry[0];
          value = entry[1];
        } else if (key.startsWith("no")) {
          key = key.substring(2);
          value = "false";
        } else {
          value = "true";
        }
        flags.put(key, value);
      } else {
        throw new IllegalCommandLineArgumentException("flag or '--' expected");
      }
    }
    return flags.build();
  }

  private static ImmutableList<String> parsePositionals(PeekingIterator<String> iterator) {
    ImmutableList.Builder<String> positionals = ImmutableList.builder();
    positionals.addAll(iterator);
    return positionals.build();
  }
}