Google Git
Sign in
android / platform / frameworks / support / 3a4a2be1562e4c67db58a72db2e229285d3b8430 / . / studiow
blob: 213da892127b0b534d9a75e20d2d4f036c0b9ceb [file] [log] [blame]
Alan Viverettea693ece2020-11-17 16:23:42 -0500[diff] [blame]1#!/usr/bin/env bash
Alan Viverettea693ece2020-11-17 16:23:42 -0500[diff] [blame]2
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]3function usage() {
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]4 echo "Usage: studiow [--clear-caches] [--clean] [--reinstall] [--profile] <project subset>"
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]5 echo
6 echo "OPTIONS"
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]7 echo
8 echo " --clear-caches"
9 echo " Clear generated caches (but not user settings) before launching"
10 echo
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]11 echo " --clean"
12 echo " Clear (with backup) generated files (settings, caches, etc) before launching"
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]13 echo " Also implies --clear-caches"
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]14 echo
15 echo " --reinstall"
16 echo " Remove and re-download Studio itself. Also implies --clean"
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]17 echo
Jeff Gaston616585c2021-12-10 12:27:27 -0500[diff] [blame]18 echo " --profile"
19 echo " Enables profiling of Studio"
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]20 echo
21 echo "Project subsets:"
22 echo " m, main"
Jeff Gaston4ac74c32021-01-29 12:12:20 -0500[diff] [blame]23 echo " Open the project subset main: non-Compose Jetpack libraries"
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]24 echo
25 echo " c, compose"
Jeff Gaston4ac74c32021-01-29 12:12:20 -0500[diff] [blame]26 echo " Open the project subset compose"
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]27 echo
Aurimas Liutikasbf1dfd42022-07-06 13:35:35 -0700[diff] [blame]28 echo " ca, camera"
29 echo " Open the project subset camera"
30 echo
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]31 echo " f, flan"
Jeff Gaston4ac74c32021-01-29 12:12:20 -0500[diff] [blame]32 echo " Open the project subset flan: Fragment, Lifecycle, Activity, and Navigation"
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]33 echo
Gyumin Simff92d182021-02-02 19:27:59 +0900[diff] [blame]34 echo " media"
35 echo " Open the project subset media: Media, Media2, and MediaRouter"
36 echo
Yigit Boyarf08b9a02022-06-02 09:16:59 -0700[diff] [blame]37 echo " kmp"
38 echo " Open the project subset KMP: Projects that have KMP builds"
39 echo
Flavio Lerda726911b2021-01-18 18:15:06 +0000[diff] [blame]40 echo " w, wear"
41 echo " Open the project subset for Wear OS libraries"
42 echo
Zak Cohenb87e89a2022-02-18 14:24:13 -0800[diff] [blame]43 echo " g, glance"
44 echo " Open the project subset for glance projects"
45 echo
Fred Sladkeye82df612022-07-14 14:50:36 -0400[diff] [blame]46 echo
47 echo " native"
Fred Sladkey8478a142022-08-30 17:27:22 -0400[diff] [blame]48 echo " Open the project subset for native projects"
Fred Sladkeye82df612022-07-14 14:50:36 -0400[diff] [blame]49 echo
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]50 echo " a, all"
Jeff Gaston4ac74c32021-01-29 12:12:20 -0500[diff] [blame]51 echo " Open the project subset all"
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]52 echo
53 exit 1
54}
55
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]56cd "$(dirname $0)"
57
58subsetArg=""
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]59clearCaches=false
60cleanSettings=false
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]61reinstall=false
62projectSubset=""
Jeff Gaston616585c2021-12-10 12:27:27 -0500[diff] [blame]63profile=false
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]64while [ "$1" != "" ]; do
65 arg="$1"
66 shift
67 # parse options
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]68 if [ "$arg" == "--clear-caches" ]; then
69 clearCaches=true
70 continue
71 fi
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]72 if [ "$arg" == "--clean" ]; then
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]73 clearCaches=true
74 cleanSettings=true
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]75 continue
76 fi
77 if [ "$arg" == "--reinstall" ]; then
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]78 clearCaches=true
79 cleanSettings=true
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]80 reinstall=true
81 continue
82 fi
Jeff Gaston616585c2021-12-10 12:27:27 -0500[diff] [blame]83 if [ "$arg" == "--profile" ]; then
84 profile=true
85 continue
86 fi
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]87 # parse arguments
88 subsetArg="$arg"
89 newSubset=""
90 if [ "$subsetArg" == "m" -o "$subsetArg" == "main" ]; then
Jeff Gaston4ac74c32021-01-29 12:12:20 -0500[diff] [blame]91 newSubset=main
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]92 fi
93 if [ "$subsetArg" == "c" -o "$subsetArg" == "compose" ]; then
Jeff Gaston4ac74c32021-01-29 12:12:20 -0500[diff] [blame]94 newSubset=compose
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]95 fi
Aurimas Liutikasbf1dfd42022-07-06 13:35:35 -0700[diff] [blame]96 if [ "$subsetArg" == "ca" -o "$subsetArg" == "camera" ]; then
97 newSubset=camera
98 fi
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]99 if [ "$subsetArg" == "f" -o "$subsetArg" == "flan" ]; then
Jeff Gaston4ac74c32021-01-29 12:12:20 -0500[diff] [blame]100 newSubset=flan
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]101 fi
Gyumin Simff92d182021-02-02 19:27:59 +0900[diff] [blame]102 if [ "$subsetArg" == "media" ]; then
103 newSubset=media
104 fi
Flavio Lerda726911b2021-01-18 18:15:06 +0000[diff] [blame]105 if [ "$subsetArg" == "w" -o "$subsetArg" == "wear" ]; then
106 newSubset=wear
107 fi
Zak Cohenb87e89a2022-02-18 14:24:13 -0800[diff] [blame]108 if [ "$subsetArg" == "g" -o "$subsetArg" == "glance" ]; then
109 newSubset=glance
110 fi
Yigit Boyarf08b9a02022-06-02 09:16:59 -0700[diff] [blame]111 if [ "$subsetArg" == "k" -o "$subsetArg" == "kmp" ]; then
112 newSubset=kmp
113 fi
Fred Sladkeye82df612022-07-14 14:50:36 -0400[diff] [blame]114 if [ "$subsetArg" == "native" ]; then
115 newSubset=native
116 fi
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]117 if [ "$subsetArg" == "a" -o "$subsetArg" == "all" ]; then
Jeff Gaston4ac74c32021-01-29 12:12:20 -0500[diff] [blame]118 newSubset=all
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]119 fi
David Saffc4b29f22022-05-19 12:23:37 -0400[diff] [blame]120 if [ "$subsetArg" == "t" -o "$subsetArg" == "tools" ]; then
121 newSubset=tools
122 fi
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]123 if [ "$newSubset" == "" ]; then
124 echo "Unrecognized argument: '$subsetArg'"
125 usage
126 fi
127 if [ "$projectSubset" != "" ]; then
128 echo "Unrecognized argument '$subsetArg', cannot specify project subset more than once"
129 usage
130 fi
131 projectSubset=$newSubset
132done
133
134if [ "$projectSubset" == "" ]; then
135 echo "Project subset is required"
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]136 usage
137fi
138
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]139export ANDROIDX_PROJECTS=$projectSubset
140
141# ensures the nonexistence of a file or directory, and makes a backup
142function remove() {
143 path="$1"
144 backup="$(dirname $path)/studio-backup/$(basename $path)"
145 if [ -e "$path" ]; then
146 echo "Moving $path to $backup"
Flavio Lerda833bae42021-11-11 15:55:34 +0000[diff] [blame]147 rm -rf "$backup"
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]148 mkdir -p "$(dirname $backup)"
149 mv "$path" "$backup"
150 fi
151}
152
153if [ "$reinstall" == "true" ]; then
154 # remove Studio itself so Gradle will re-download it
Flavio Lerda833bae42021-11-11 15:55:34 +0000[diff] [blame]155 rm -rf studio
Jeff Gastond25425c2020-12-02 09:53:57 -0500[diff] [blame]156fi
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]157
Jeff Gaston616585c2021-12-10 12:27:27 -0500[diff] [blame]158if [ "$profile" == "true" ]; then
159 PROFILE_FILE=/tmp/report.json
160 traceConfig="$(cd development/studio && pwd)/profile.config"
161 rm -f "$PROFILE_FILE"
162 echo "Profile file will be $PROFILE_FILE , which will be able to be loaded into chrome://tracing"
163 echo
164 echo "If you find that too many or too few function calls are included in the trace, modify $traceConfig"
165 echo
166 tracerJar="$(cd ../../prebuilts/androidx/external/com/android/tools/tracer/agent && pwd)/trace_agent.jar"
167 # Make sure to set _JAVA_OPTIONS before starting Gradle
168 export _JAVA_OPTIONS="$_JAVA_OPTIONS -javaagent:${tracerJar}=${traceConfig}"
169fi
170
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]171# remove studio-specific caches
172if [ "$cleanSettings" == "true" ]; then
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]173 # make backups of files that users might have customized
174 remove ~/.AndroidStudioAndroidX
175 remove ~/.AndroidStudioAndroidXPlayground
176 remove ~/.android
Jeff Gaston05651442022-01-26 12:56:58 -0500[diff] [blame]177fi
178
179if [ "$clearCaches" == "true" ]; then
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]180 # delete (without backup) files that users won't have customized
181 git clean -fdX .idea/
Jeff Gaston616585c2021-12-10 12:27:27 -0500[diff] [blame]182
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]183 # remove gradle caches too and build
184 ./cleanBuild.sh -y studio
185else
Jeff Gaston616585c2021-12-10 12:27:27 -0500[diff] [blame]186 # If not a clean launch, then a Gradle daemon might be running.
187 # If profiling, we need to stop the Gradle daemon to make sure any changes to the
188 # profiling properties will be used.
189 if [ "$profile" == "true" ]; then
190 ./gradlew --stop
191 fi
192
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]193 # ask gradle to launch studio
Aurimas Liutikas0db05722021-07-20 13:06:27 -0700[diff] [blame]194 ./gradlew :studio
Jeff Gaston1db6bb82020-12-22 13:12:23 -0500[diff] [blame]195fi