gcc/gcc-urlifier.cc

   1 /* Automatic generation of links into GCC's documentation.
   2    Copyright (C) 2023 Free Software Foundation, Inc.
   3    Contributed by David Malcolm <dmalcolm@redhat.com>.
   4
   5 This file is part of GCC.
   6
   7 GCC is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 3, or (at your option) any later
  10 version.
  11
  12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GCC; see the file COPYING3.  If not see
  19 <http://www.gnu.org/licenses/>.  */
  20
  21 #include "config.h"
  22 #include "system.h"
  23 #include "coretypes.h"
  24 #include "pretty-print.h"
  25 #include "pretty-print-urlifier.h"
  26 #include "gcc-urlifier.h"
  27 #include "selftest.h"
  28
  29 namespace {
  30
  31 /* Concrete subclass of urlifier for generating links into
  32    GCC's HTML documentation.  */
  33
  34 class gcc_urlifier : public urlifier
  35 {
  36 public:
  37   char *get_url_for_quoted_text (const char *p, size_t sz) const final override;
  38
  39   const char *get_url_suffix_for_quoted_text (const char *p, size_t sz) const;
  40   /* We use ATTRIBUTE_UNUSED as this helper is called only from ASSERTs.  */
  41   const char *get_url_suffix_for_quoted_text (const char *p) const ATTRIBUTE_UNUSED;
  42
  43 private:
  44   static char *
  45   make_doc_url (const char *doc_url_suffix);
  46 };
  47
  48 /* class gcc_urlifier : public urlifier.  */
  49
  50 #define DOC_URL(QUOTED_TEXT, URL_SUFFIX) \
  51   { (QUOTED_TEXT), (URL_SUFFIX) }
  52
  53 const struct
  54 {
  55   const char *quoted_text;
  56   const char *url_suffix;
  57 } doc_urls[] = {
  58
  59 #include "gcc-urlifier.def"
  60
  61 };
  62
  63 char *
  64 gcc_urlifier::get_url_for_quoted_text (const char *p, size_t sz) const
  65 {
  66   if (const char *url_suffix = get_url_suffix_for_quoted_text (p, sz))
  67     return make_doc_url (url_suffix);
  68   return nullptr;
  69 }
  70
  71 const char *
  72 gcc_urlifier::get_url_suffix_for_quoted_text (const char *p, size_t sz) const
  73 {
  74   /* Binary search.  This assumes that the quoted_text fields of doc_urls
  75      are in sorted order.  */
  76   int min = 0;
  77   int max = ARRAY_SIZE (doc_urls) - 1;
  78   while (true)
  79     {
  80       if (min > max)
  81         return nullptr;
  82       int midpoint = (min + max) / 2;
  83       gcc_assert ((size_t)midpoint < ARRAY_SIZE (doc_urls));
  84       int cmp = strncmp (p, doc_urls[midpoint].quoted_text, sz);
  85       if (cmp == 0)
  86         {
  87           if (doc_urls[midpoint].quoted_text[sz] == '\0')
  88             return doc_urls[midpoint].url_suffix;
  89           else
  90             max = midpoint - 1;
  91         }
  92       else if (cmp < 0)
  93         max = midpoint - 1;
  94       else
  95         min = midpoint + 1;
  96     }
  97   return nullptr;
  98 }
  99
 100 const char *
 101 gcc_urlifier::get_url_suffix_for_quoted_text (const char *p) const
 102 {
 103   return get_url_suffix_for_quoted_text (p, strlen (p));
 104 }
 105
 106 char *
 107 gcc_urlifier::make_doc_url (const char *doc_url_suffix)
 108 {
 109   if (!doc_url_suffix)
 110     return nullptr;
 111
 112   return concat (DOCUMENTATION_ROOT_URL, doc_url_suffix, nullptr);
 113 }
 114
 115 } // anonymous namespace
 116
 117 urlifier *
 118 make_gcc_urlifier ()
 119 {
 120   return new gcc_urlifier ();
 121 }
 122
 123 #if CHECKING_P
 124
 125 namespace selftest {
 126
 127 /* Selftests.  */
 128
 129 /* Run all of the selftests within this file.  */
 130
 131 void
 132 gcc_urlifier_cc_tests ()
 133 {
 134   /* Check that doc_urls.quoted_text is sorted.  */
 135   for (size_t idx = 1; idx < ARRAY_SIZE (doc_urls); idx++)
 136     gcc_assert (strcmp (doc_urls[idx - 1].quoted_text,
 137                         doc_urls[idx].quoted_text)
 138                 < 0);
 139
 140   gcc_urlifier u;
 141
 142   ASSERT_EQ (u.get_url_suffix_for_quoted_text (""), nullptr);
 143   ASSERT_EQ (u.get_url_suffix_for_quoted_text (")"), nullptr);
 144
 145   ASSERT_STREQ (u.get_url_suffix_for_quoted_text ("#pragma message"),
 146                 "gcc/Diagnostic-Pragmas.html");
 147
 148   // Incomplete prefix of a quoted_text
 149   ASSERT_EQ (u.get_url_suffix_for_quoted_text ("#pragma mess"), nullptr);
 150
 151   /* Check that every element is findable.  */
 152   for (size_t idx = 0; idx < ARRAY_SIZE (doc_urls); idx++)
 153     ASSERT_STREQ
 154       (u.get_url_suffix_for_quoted_text (doc_urls[idx].quoted_text),
 155        doc_urls[idx].url_suffix);
 156 }
 157
 158 } // namespace selftest
 159
 160 #endif /* #if CHECKING_P */