Home | History | Annotate | Download | only in link
      1 /*
      2  * Copyright (C) 2015 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 #ifndef AAPT_LINK_MANIFESTFIXER_H
     18 #define AAPT_LINK_MANIFESTFIXER_H
     19 
     20 #include <string>
     21 
     22 #include "android-base/macros.h"
     23 
     24 #include "process/IResourceTableConsumer.h"
     25 #include "util/Maybe.h"
     26 #include "xml/XmlActionExecutor.h"
     27 #include "xml/XmlDom.h"
     28 
     29 namespace aapt {
     30 
     31 struct ManifestFixerOptions {
     32   // The minimum SDK version to set if no 'android:minSdkVersion' is defined in a <uses-sdk> tag.
     33   Maybe<std::string> min_sdk_version_default;
     34 
     35   // The target SDK version to set if no 'android:targetSdkVersion' is defined in a <uses-sdk> tag.
     36   Maybe<std::string> target_sdk_version_default;
     37 
     38   // The Android package to use instead of the one defined in 'package' in <manifest>.
     39   // This also renames all relative package/class names in the manifest to fully qualified
     40   // Java names.
     41   Maybe<std::string> rename_manifest_package;
     42 
     43   // The Android package to use instead of the one defined in 'android:targetPackage' in
     44   // <instrumentation>.
     45   Maybe<std::string> rename_instrumentation_target_package;
     46 
     47   // The version name to set if 'android:versionName' is not defined in <manifest> or if
     48   // replace_version is set.
     49   Maybe<std::string> version_name_default;
     50 
     51   // The version code to set if 'android:versionCode' is not defined in <manifest> or if
     52   // replace_version is set.
     53   Maybe<std::string> version_code_default;
     54 
     55   // The version code to set if 'android:versionCodeMajor' is not defined in <manifest> or if
     56   // replace_version is set.
     57   Maybe<std::string> version_code_major_default;
     58 
     59   // The version of the framework being compiled against to set for 'android:compileSdkVersion' in
     60   // the <manifest> tag.
     61   Maybe<std::string> compile_sdk_version;
     62 
     63   // The version codename of the framework being compiled against to set for
     64   // 'android:compileSdkVersionCodename' in the <manifest> tag.
     65   Maybe<std::string> compile_sdk_version_codename;
     66 
     67   // Whether validation errors should be treated only as warnings. If this is 'true', then an
     68   // incorrect node will not result in an error, but only as a warning, and the parsing will
     69   // continue.
     70   bool warn_validation = false;
     71 
     72   // Whether to inject the android:debuggable="true" flag into the manifest
     73   bool debug_mode = false;
     74 
     75   // Whether to replace the manifest version with the the command line version
     76   bool replace_version = false;
     77 };
     78 
     79 // Verifies that the manifest is correctly formed and inserts defaults where specified with
     80 // ManifestFixerOptions.
     81 class ManifestFixer : public IXmlResourceConsumer {
     82  public:
     83   explicit ManifestFixer(const ManifestFixerOptions& options) : options_(options) {
     84   }
     85 
     86   bool Consume(IAaptContext* context, xml::XmlResource* doc) override;
     87 
     88  private:
     89   DISALLOW_COPY_AND_ASSIGN(ManifestFixer);
     90 
     91   bool BuildRules(xml::XmlActionExecutor* executor, IDiagnostics* diag);
     92 
     93   ManifestFixerOptions options_;
     94 };
     95 
     96 }  // namespace aapt
     97 
     98 #endif /* AAPT_LINK_MANIFESTFIXER_H */
     99