WikiVisitUrls.java

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.helger.css.supplementary.wiki;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.css.CSSSourceLocation;
import com.helger.css.ECSSVersion;
import com.helger.css.decl.CSSDeclaration;
import com.helger.css.decl.CSSExpressionMemberTermURI;
import com.helger.css.decl.CSSImportRule;
import com.helger.css.decl.CascadingStyleSheet;
import com.helger.css.decl.ICSSTopLevelRule;
import com.helger.css.decl.visit.CSSVisitor;
import com.helger.css.decl.visit.DefaultCSSUrlVisitor;
import com.helger.css.reader.CSSReader;

/**
 * Example how to extract all URLs from a certain CSS file using a
 * {@link DefaultCSSUrlVisitor}.
 *
 * @author Philip Helger
 */
public final class WikiVisitUrls
{
  public static String getSourceLocationString (@Nonnull final CSSSourceLocation aSourceLoc)
  {
    return "source location reaches from [" +
           aSourceLoc.getFirstTokenBeginLineNumber () +
           "/" +
           aSourceLoc.getFirstTokenBeginColumnNumber () +
           "] up to [" +
           aSourceLoc.getLastTokenEndLineNumber () +
           "/" +
           aSourceLoc.getLastTokenEndColumnNumber () +
           "]";
  }

  public void readFromStyleAttributeWithAPI ()
  {
    final String sStyle = "@import 'foobar.css';\n" +
                          "div{background:fixed url(a.gif) !important;}\n" +
                          "span { background-image:url('/my/folder/b.gif');}";
    final CascadingStyleSheet aCSS = CSSReader.readFromString (sStyle, ECSSVersion.CSS30);
    CSSVisitor.visitCSSUrl (aCSS, new DefaultCSSUrlVisitor ()
    {
      // Called for each import
      @Override
      public void onImport (@Nonnull final CSSImportRule aImportRule)
      {
        System.out.println ("Import: " +
                            aImportRule.getLocationString () +
                            " - " +
                            getSourceLocationString (aImportRule.getSourceLocation ()));
      }

      // Call for URLs outside of URLs
      @Override
      public void onUrlDeclaration (@Nullable final ICSSTopLevelRule aTopLevelRule,
                                    @Nonnull final CSSDeclaration aDeclaration,
                                    @Nonnull final CSSExpressionMemberTermURI aURITerm)
      {
        System.out.println (aDeclaration.getProperty () +
                            " - references: " +
                            aURITerm.getURIString () +
                            " - " +
                            getSourceLocationString (aURITerm.getSourceLocation ()));
      }
    });
  }
}