001///////////////////////////////////////////////////////////////////////////////////////////////
002// checkstyle: Checks Java source code and other text files for adherence to a set of rules.
003// Copyright (C) 2001-2025 the original author or authors.
004//
005// This library is free software; you can redistribute it and/or
006// modify it under the terms of the GNU Lesser General Public
007// License as published by the Free Software Foundation; either
008// version 2.1 of the License, or (at your option) any later version.
009//
010// This library is distributed in the hope that it will be useful,
011// but WITHOUT ANY WARRANTY; without even the implied warranty of
012// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
013// Lesser General Public License for more details.
014//
015// You should have received a copy of the GNU Lesser General Public
016// License along with this library; if not, write to the Free Software
017// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
018///////////////////////////////////////////////////////////////////////////////////////////////
019
020package com.puppycrawl.tools.checkstyle.site;
021
022import java.nio.file.Path;
023import java.nio.file.Paths;
024import java.util.Set;
025
026import org.apache.maven.doxia.macro.AbstractMacro;
027import org.apache.maven.doxia.macro.Macro;
028import org.apache.maven.doxia.macro.MacroExecutionException;
029import org.apache.maven.doxia.macro.MacroRequest;
030import org.apache.maven.doxia.sink.Sink;
031import org.codehaus.plexus.component.annotations.Component;
032
033import com.puppycrawl.tools.checkstyle.api.DetailNode;
034import com.puppycrawl.tools.checkstyle.utils.CommonUtil;
035
036/**
037 * A macro that inserts a description of module from its Javadoc.
038 */
039@Component(role = Macro.class, hint = "description")
040public class DescriptionMacro extends AbstractMacro {
041
042    @Override
043    public void execute(Sink sink, MacroRequest request) throws MacroExecutionException {
044        final Path modulePath = Paths.get((String) request.getParameter("modulePath"));
045        final String moduleName = CommonUtil.getFileNameWithoutExtension(modulePath.toString());
046
047        final Set<String> propertyNames = ModuleJavadocParsingUtil.getPropertyNames(moduleName);
048
049        final DetailNode moduleJavadoc = SiteUtil.getModuleJavadoc(moduleName, modulePath);
050        if (moduleJavadoc == null) {
051            throw new MacroExecutionException(
052                "Javadoc of module " + moduleName + " is not found.");
053        }
054
055        final String moduleDescription = ModuleJavadocParsingUtil.getModuleDescription(
056            moduleJavadoc, propertyNames);
057
058        ModuleJavadocParsingUtil.writeOutJavadocPortion(moduleDescription, sink);
059
060    }
061
062}