From caf7b0a155f6adef1b9af6cbf7370460c55e3a3f Mon Sep 17 00:00:00 2001 From: Jeff Brown Date: Thu, 25 Apr 2013 21:24:44 -0700 Subject: [PATCH] Generate SDK docs for v7 support library packages. This change required fixing some bugs in how AAPT handles qualified symbols such as "android:layout_height" when generating JavaDoc links. The links were being generated using the package name of the generated R file rather than the package name of the referenced symbol. These broken links caused the JavaDoc build to fail. Bug: 8175766 Change-Id: I52fbef27825a25abca960cb44b59c2132267e9d6 --- Android.mk | 35 +++++++---- core/res/res/values/attrs.xml | 2 +- tools/aapt/Resource.cpp | 114 ++++++++++++++++------------------ 3 files changed, 78 insertions(+), 73 deletions(-) diff --git a/Android.mk b/Android.mk index 849ec8cb1a395..d910d356b940e 100644 --- a/Android.mk +++ b/Android.mk @@ -409,18 +409,22 @@ framework_docs_LOCAL_DROIDDOC_SOURCE_PATH := \ $(FRAMEWORKS_BASE_JAVA_SRC_DIRS) framework_docs_LOCAL_INTERMEDIATE_SOURCES := \ - $(framework_res_source_path)/android/R.java \ - $(framework_res_source_path)/android/Manifest.java \ - $(framework_res_source_path)/com/android/internal/R.java + $(framework_res_source_path)/android/R.java \ + $(framework_res_source_path)/android/Manifest.java \ + $(framework_res_source_path)/com/android/internal/R.java + +framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES := \ + bouncycastle \ + core \ + ext \ + framework \ + mms-common \ + telephony-common \ + voip-common framework_docs_LOCAL_JAVA_LIBRARIES := \ - bouncycastle \ - core \ - ext \ - framework \ - mms-common \ - telephony-common \ - voip-common \ + $(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES) \ + $(FRAMEWORKS_SUPPORT_JAVA_LIBRARIES) framework_docs_LOCAL_MODULE_CLASS := JAVA_LIBRARIES framework_docs_LOCAL_DROIDDOC_HTML_DIR := docs/html @@ -449,7 +453,12 @@ framework_docs_LOCAL_DROIDDOC_OPTIONS := \ -werror -hide 113 \ -overview $(LOCAL_PATH)/core/java/overview.html -framework_docs_LOCAL_ADDITIONAL_JAVA_DIR:= $(call intermediates-dir-for,JAVA_LIBRARIES,framework,,COMMON) +framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR:= \ + $(call intermediates-dir-for,JAVA_LIBRARIES,framework,,COMMON) + +framework_docs_LOCAL_ADDITIONAL_JAVA_DIR:= \ + $(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR) \ + $(foreach lib,$(FRAMEWORKS_SUPPORT_JAVA_LIBRARIES),$(call intermediates-dir-for,JAVA_LIBRARIES,$(lib),,COMMON)) framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES := \ frameworks/base/docs/knowntags.txt @@ -571,11 +580,11 @@ include $(CLEAR_VARS) LOCAL_SRC_FILES:=$(framework_docs_LOCAL_API_CHECK_SRC_FILES) LOCAL_INTERMEDIATE_SOURCES:=$(framework_docs_LOCAL_INTERMEDIATE_SOURCES) -LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_JAVA_LIBRARIES) +LOCAL_JAVA_LIBRARIES:=$(framework_docs_LOCAL_API_CHECK_JAVA_LIBRARIES) LOCAL_MODULE_CLASS:=$(framework_docs_LOCAL_MODULE_CLASS) LOCAL_DROIDDOC_SOURCE_PATH:=$(framework_docs_LOCAL_DROIDDOC_SOURCE_PATH) LOCAL_DROIDDOC_HTML_DIR:=$(framework_docs_LOCAL_DROIDDOC_HTML_DIR) -LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_ADDITIONAL_JAVA_DIR) +LOCAL_ADDITIONAL_JAVA_DIR:=$(framework_docs_LOCAL_API_CHECK_ADDITIONAL_JAVA_DIR) LOCAL_ADDITIONAL_DEPENDENCIES:=$(framework_docs_LOCAL_ADDITIONAL_DEPENDENCIES) LOCAL_MODULE := api-stubs diff --git a/core/res/res/values/attrs.xml b/core/res/res/values/attrs.xml index 60f3f3250c795..4dcbaec26e30e 100644 --- a/core/res/res/values/attrs.xml +++ b/core/res/res/values/attrs.xml @@ -3548,7 +3548,7 @@ + {@code @android:id/text1} to be populated with the prompt text. --> diff --git a/tools/aapt/Resource.cpp b/tools/aapt/Resource.cpp index 77168f948640f..6168bbdc06551 100644 --- a/tools/aapt/Resource.cpp +++ b/tools/aapt/Resource.cpp @@ -1568,11 +1568,37 @@ static const char whitespace[] = return whitespace + sizeof(whitespace) - 1 - indent*4; } -static status_t fixupSymbol(String16* inoutSymbol) -{ - inoutSymbol->replaceAll('.', '_'); - inoutSymbol->replaceAll(':', '_'); - return NO_ERROR; +static String8 flattenSymbol(const String8& symbol) { + String8 result(symbol); + ssize_t first; + if ((first = symbol.find(":", 0)) >= 0 + || (first = symbol.find(".", 0)) >= 0) { + size_t size = symbol.size(); + char* buf = result.lockBuffer(size); + for (size_t i = first; i < size; i++) { + if (buf[i] == ':' || buf[i] == '.') { + buf[i] = '_'; + } + } + result.unlockBuffer(size); + } + return result; +} + +static String8 getSymbolPackage(const String8& symbol, const sp& assets, bool pub) { + ssize_t colon = symbol.find(":", 0); + if (colon >= 0) { + return String8(symbol.string(), colon); + } + return pub ? assets->getPackage() : assets->getSymbolsPrivatePackage(); +} + +static String8 getSymbolName(const String8& symbol) { + ssize_t colon = symbol.find(":", 0); + if (colon >= 0) { + return String8(symbol.string() + colon + 1); + } + return symbol; } static String16 getAttributeComment(const sp& assets, @@ -1616,12 +1642,8 @@ static status_t writeLayoutClasses( size_t N = symbols->getNestedSymbols().size(); for (i=0; i nsymbols = symbols->getNestedSymbols().valueAt(i); - String16 nclassName16(symbols->getNestedSymbols().keyAt(i)); - String8 realClassName(nclassName16); - if (fixupSymbol(&nclassName16) != NO_ERROR) { - hasErrors = true; - } - String8 nclassName(nclassName16); + String8 realClassName(symbols->getNestedSymbols().keyAt(i)); + String8 nclassName(flattenSymbol(realClassName)); SortedVector idents; Vector origOrder; @@ -1711,13 +1733,11 @@ static status_t writeLayoutClasses( } comment = String16(comment.string(), p-comment.string()); } - String16 name(name8); - fixupSymbol(&name); fprintf(fp, "%s {@link #%s_%s %s:%s}%s\n", indentStr, nclassName.string(), - String8(name).string(), - assets->getPackage().string(), - String8(name).string(), + flattenSymbol(name8).string(), + getSymbolPackage(name8, assets, true).string(), + getSymbolName(name8).string(), String8(comment).string()); } } @@ -1731,11 +1751,9 @@ static status_t writeLayoutClasses( if (!publicFlags.itemAt(a) && !includePrivate) { continue; } - String16 name(sym.name); - fixupSymbol(&name); fprintf(fp, "%s @see #%s_%s\n", indentStr, nclassName.string(), - String8(name).string()); + flattenSymbol(sym.name).string()); } } fprintf(fp, "%s */\n", getIndentSpace(indent)); @@ -1778,11 +1796,7 @@ static status_t writeLayoutClasses( } else { getAttributeComment(assets, name8, &typeComment); } - String16 name(name8); - if (fixupSymbol(&name) != NO_ERROR) { - hasErrors = true; - } - + uint32_t typeSpecFlags = 0; String16 name16(sym.name); assets->getIncludedResources().identifierForName( @@ -1808,9 +1822,8 @@ static status_t writeLayoutClasses( "%s

This symbol is the offset where the {@link %s.R.attr#%s}\n" "%s attribute's value can be found in the {@link #%s} array.\n", indentStr, - pub ? assets->getPackage().string() - : assets->getSymbolsPrivatePackage().string(), - String8(name).string(), + getSymbolPackage(name8, assets, pub).string(), + getSymbolName(name8).string(), indentStr, nclassName.string()); } if (typeComment.size() > 0) { @@ -1823,18 +1836,19 @@ static status_t writeLayoutClasses( if (comment.size() > 0) { if (pub) { fprintf(fp, - "%s

This corresponds to the global attribute" + "%s

This corresponds to the global attribute\n" "%s resource symbol {@link %s.R.attr#%s}.\n", indentStr, indentStr, - assets->getPackage().string(), - String8(name).string()); + getSymbolPackage(name8, assets, true).string(), + getSymbolName(name8).string()); } else { fprintf(fp, "%s

This is a private symbol.\n", indentStr); } } fprintf(fp, "%s @attr name %s:%s\n", indentStr, - "android", String8(name).string()); + getSymbolPackage(name8, assets, pub).string(), + getSymbolName(name8).string()); fprintf(fp, "%s*/\n", indentStr); if (deprecated) { fprintf(fp, "%s@Deprecated\n", indentStr); @@ -1842,7 +1856,7 @@ static status_t writeLayoutClasses( fprintf(fp, "%spublic static final int %s_%s = %d;\n", indentStr, nclassName.string(), - String8(name).string(), (int)pos); + flattenSymbol(name8).string(), (int)pos); } } } @@ -1865,12 +1879,8 @@ static status_t writeTextLayoutClasses( size_t N = symbols->getNestedSymbols().size(); for (i=0; i nsymbols = symbols->getNestedSymbols().valueAt(i); - String16 nclassName16(symbols->getNestedSymbols().keyAt(i)); - String8 realClassName(nclassName16); - if (fixupSymbol(&nclassName16) != NO_ERROR) { - hasErrors = true; - } - String8 nclassName(nclassName16); + String8 realClassName(symbols->getNestedSymbols().keyAt(i)); + String8 nclassName(flattenSymbol(realClassName)); SortedVector idents; Vector origOrder; @@ -1930,10 +1940,6 @@ static status_t writeTextLayoutClasses( } else { getAttributeComment(assets, name8, &typeComment); } - String16 name(name8); - if (fixupSymbol(&name) != NO_ERROR) { - hasErrors = true; - } uint32_t typeSpecFlags = 0; String16 name16(sym.name); @@ -1948,7 +1954,7 @@ static status_t writeTextLayoutClasses( fprintf(fp, "int styleable %s_%s %d\n", nclassName.string(), - String8(name).string(), (int)pos); + flattenSymbol(name8).string(), (int)pos); } } } @@ -1982,10 +1988,7 @@ static status_t writeSymbolClass( if (!assets->isJavaSymbol(sym, includePrivate)) { continue; } - String16 name(sym.name); - if (fixupSymbol(&name) != NO_ERROR) { - return UNKNOWN_ERROR; - } + String8 name8(sym.name); String16 comment(sym.comment); bool haveComment = false; bool deprecated = false; @@ -2026,7 +2029,7 @@ static status_t writeSymbolClass( } fprintf(fp, id_format, getIndentSpace(indent), - String8(name).string(), (int)sym.int32Val); + flattenSymbol(name8).string(), (int)sym.int32Val); } for (i=0; iisJavaSymbol(sym, includePrivate)) { continue; } - String16 name(sym.name); - if (fixupSymbol(&name) != NO_ERROR) { - return UNKNOWN_ERROR; - } + String8 name8(sym.name); String16 comment(sym.comment); bool deprecated = false; if (comment.size() > 0) { @@ -2063,7 +2063,7 @@ static status_t writeSymbolClass( } fprintf(fp, "%spublic static final String %s=\"%s\";\n", getIndentSpace(indent), - String8(name).string(), sym.stringVal.string()); + flattenSymbol(name8).string(), sym.stringVal.string()); } sp styleableSymbols; @@ -2112,14 +2112,10 @@ static status_t writeTextSymbolClass( continue; } - String16 name(sym.name); - if (fixupSymbol(&name) != NO_ERROR) { - return UNKNOWN_ERROR; - } - + String8 name8(sym.name); fprintf(fp, "int %s %s 0x%08x\n", className.string(), - String8(name).string(), (int)sym.int32Val); + flattenSymbol(name8).string(), (int)sym.int32Val); } N = symbols->getNestedSymbols().size();