Examples of org.openquark.cal.compiler.ModuleName

org.openquark.cal.compiler.ModuleName
This class abstracts a module name in CAL. A module name is composed of one or more components separated by dots. For example, Foo and Cal.Core.Prelude are valid module names. Each component must start with an uppercase letter. @author Joseph Wong


        final SortedMap<String, ModuleName> displayNameToModuleNameMap = getAbbreviatedModuleNameToModuleNameMap();
        
        for (final Map.Entry<String, ModuleName> entry : displayNameToModuleNameMap.entrySet()) {
            final String displayName = entry.getKey();
            final ModuleName moduleName = entry.getValue();
            final String fullyQualifiedNameForModule = moduleName.toSourceText();
            
            generateNonLocalReference(currentPage, MODULES_SUBDIRECTORY, moduleName, labelMaker.getModuleLabel(moduleName), displayName, fullyQualifiedNameForModule);
            currentPage.emptyTag(HTML.Tag.BR).newline();
        }
    }

View Full Code Here

    private SortedMap<String, ModuleName> getAbbreviatedModuleNameToModuleNameMap() {
        final SortedMap<String, ModuleName> displayNameToModuleNameMap = new TreeMap<String, ModuleName>();
        
        for (final ModuleName moduleName : moduleIndices.keySet()) {
            final String lastComponent = moduleName.getLastComponent();
            final ModuleName minimallyQualifiedModuleName = getModuleNameResolverForDocumentedModules().getMinimallyQualifiedModuleName(moduleName);


            final String displayName;
            
            if (minimallyQualifiedModuleName.getNComponents() == 1) {
                displayName = lastComponent;
                
            } else {
                final int nMinusOne = minimallyQualifiedModuleName.getNComponents() - 1;


                final StringBuilder sb = new StringBuilder(lastComponent).append(" (");


                for (int i = 0; i < nMinusOne; i++) {
                    if (i > 0) {
                        sb.append(CALFragments.DOT);
                    }
                    sb.append(minimallyQualifiedModuleName.getNthComponent(i));
                }
                sb.append(")");
                displayName = sb.toString();
            }

View Full Code Here

        
        currentPage.openTag(HTML.Tag.DIV, idAndClassAttributes(moduleTreeNodeElementID, StyleClassConstants.TREE_DIV_OVERVIEW_PAGE));
        
        for (final Map.Entry<Pair<ModuleName, Boolean>, ModuleHierarchyInfo> entry : node.getChildren().entrySet()) {
            final Pair<ModuleName, Boolean> key = entry.getKey();
            final ModuleName childName = key.fst();
            final boolean childIsActualModule = key.snd().booleanValue();
            final ModuleHierarchyInfo child = entry.getValue();
            final String childDisplayName = childName.getNthComponent(level);
            final String fullyQualifiedNameForChildModule = getFullyQualifiedNameForModule(childName);
            
            final String childDivElementID = getModuleTreeNodeElementID("ovwH", childName);


            currentPage.openTag(HTML.Tag.DIV);

View Full Code Here

        
        currentPage.openTag(HTML.Tag.DIV, idAndClassAttributes(moduleTreeNodeElementID, StyleClassConstants.TREE_DIV_OVERVIEW_PAGE));
        
        for (final Map.Entry<Pair<ModuleName, Boolean>, ModuleHierarchyInfo> entry : node.getChildren().entrySet()) {
            final Pair<ModuleName, Boolean> key = entry.getKey();
            final ModuleName childName = key.fst();
            final boolean childIsActualModule = key.snd().booleanValue();
            final ModuleHierarchyInfo child = entry.getValue();
            final String childDisplayName = isChildLevel ? childName.getLastComponent() : childName.toSourceText();
            final String fullyQualifiedNameForChildModule = getFullyQualifiedNameForModule(childName);
            
            final String childDivElementID = getModuleTreeNodeElementID("ovwG", childName);
            
            currentPage.openTag(HTML.Tag.DIV);

View Full Code Here


        final SortedMap<String, ModuleName> displayNameToModuleNameMap = getAbbreviatedModuleNameToModuleNameMap();
        
        for (final Map.Entry<String, ModuleName> entry : displayNameToModuleNameMap.entrySet()) {
            final String displayName = entry.getKey();
            final ModuleName moduleName = entry.getValue();
            final String fullyQualifiedNameForModule = moduleName.toSourceText();
            
            currentPage.openTag(HTML.Tag.DL, classAttribute(StyleClassConstants.DL_OVERVIEW_PAGE)).openTag(HTML.Tag.DT);
            generateNonLocalReference(currentPage, MODULES_SUBDIRECTORY, moduleName, labelMaker.getModuleLabel(moduleName), displayName, fullyQualifiedNameForModule);
            
            currentPage.closeTag(HTML.Tag.DT).openTag(HTML.Tag.DD);

View Full Code Here

        
        generateUpdateScopeDisplaySettingsJavascript();


        /// If the module name has more than one component, break it up into two pieces: the immediate prefix and the last component
        //
        final ModuleName immediatePrefix = currentModuleName.getImmediatePrefix();
        if (immediatePrefix != null) {
            currentPage.addTaggedText(HTML.Tag.DIV, classAttribute(StyleClassConstants.SIDE_BAR_KHAKI_SUPERTITLE), immediatePrefix.toSourceText());
        }
        currentPage.addTaggedText(HTML.Tag.H2, classAttribute(StyleClassConstants.SIDE_BAR_KHAKI_TITLE), currentModuleName.getLastComponent());
        
        currentPage.openTag(HTML.Tag.DIV, classAttribute(StyleClassConstants.INDEX_NAV));

View Full Code Here

     * Constructs a file name for the type usage indices page from a type constructor name, properly disambiguated.
     * @param qualifiedName the qualified name of the type constructor.
     * @return the corresponding file name.
     */
    private String getTypeConsUsageIndexFileName(QualifiedName qualifiedName) {
        ModuleName moduleName = qualifiedName.getModuleName();
        return getDisambiguatedNameForModule(moduleName) + DOT + getDisambiguatedNameForTypeCons(moduleName, qualifiedName.getUnqualifiedName()) + DOT + HTML_FILE_EXTENSION;
    }

View Full Code Here

     * Constructs a file name for the type class usage indices page from a type class name, properly disambiguated.
     * @param qualifiedName the qualified name of the type class.
     * @return the corresponding file name.
     */
    private String getTypeClassUsageIndexFileName(QualifiedName qualifiedName) {
        ModuleName moduleName = qualifiedName.getModuleName();
        return getDisambiguatedNameForModule(moduleName) + DOT + getDisambiguatedNameForTypeClass(moduleName, qualifiedName.getUnqualifiedName()) + DOT + HTML_FILE_EXTENSION;
    }

View Full Code Here

     * @param builder the HTMLBuilder for generating the reference.
     * @param relativeDirectory the relative directory path to get to the modules subdirectory. Can be null if the current directory is the modules subdirectory.
     * @param reference the name of the module to link to.
     */
    private void generateModuleReference(HTMLBuilder builder, String relativeDirectory, CALDocComment.ModuleReference reference) {
        ModuleName moduleName = reference.getName();
        String displayName = reference.getModuleNameInSource();
        if (displayName.length() == 0) {
            displayName = getMinimallyQualifiedNameForModule(moduleName);
        }
        generateModuleReference(builder, relativeDirectory, moduleName, displayName);

View Full Code Here

    /**
     * Generates a reference to a class instance, appropriately hyperlinked.
     * @param classInstance the class instance to link to.
     */
    private void generateClassInstanceReference(ClassInstance classInstance) {
        ModuleName definingModuleName = classInstance.getModuleName();
        ClassInstanceIdentifier identifier = classInstance.getIdentifier();
        String classInstanceLabel = labelMaker.getClassInstanceLabel(identifier);
        
        if (!isDocForClassInstanceGenerated(classInstance)) {
            // if the class instance is not documented, no hyperlink can be made.
            generateClassInstanceDeclarationName(classInstance, false);
            
        } else {
            // the instance is indeed documented, so create a hyperlinked reference to it
            
            HTMLBuilder.AttributeList hrefAttribute;
            if (config.shouldSeparateInstanceDoc) {
                if (inSeparateInstanceDoc) {
                    if (definingModuleName == null || definingModuleName.equals(currentModuleName)) {
                        hrefAttribute = localHrefAttribute(classInstanceLabel);
                    } else {
                        hrefAttribute = nonLocalHrefAttribute(getSeparateInstanceDocFileName(definingModuleName), classInstanceLabel);
                    }
                } else {
                    hrefAttribute = nonLocalHrefAttribute("../" + SEPARATE_INSTANCE_DOC_SUBDIRECTORY + "/" + getSeparateInstanceDocFileName(definingModuleName), classInstanceLabel);
                }
            } else {
                if (definingModuleName == null || definingModuleName.equals(currentModuleName)) {
                    hrefAttribute = localHrefAttribute(classInstanceLabel);
                } else {
                    hrefAttribute = nonLocalHrefAttribute(getModuleFileName(definingModuleName), classInstanceLabel);
                }
            }

View Full Code Here

0 1 2 3 4 5 6 7 8 9

TOP

Related Classes of org.openquark.cal.compiler.ModuleName

org.openquark.cal.benchmarks.shootout.Chameneos

org.openquark.cal.benchmarks.shootout.Messages

org.openquark.cal.CAL$CommandLineOptions

org.openquark.cal.caldoc.AbstractDocumentationGenerator

org.openquark.cal.caldoc.AbstractDocumentationGenerator$EnvEntityProcessorForArgAndReturnTypeIndices

org.openquark.cal.caldoc.CALDocTool_Test$CustomFileGenerator

org.openquark.cal.caldoc.HTMLDocumentationGenerator

org.openquark.cal.ConsoleRunner

org.openquark.cal.DrawTest$CALServicesHelper

org.openquark.cal.ICE

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.