require(): Extend syntax to "require(TYPE VALUE)".

"require(package VALUE)" is the new version of "require(PACKAGE)";
for backwards compatibility "require(PACKAGE)" also works.

The idea is to pave the way for, say, "require(library VALUE)", which might
be a version of #include.

bsdmodule/config.cc

@@ -66,14 +66,14 @@ read_classes(Element *, void *)
 
 class BSDModuleLexerExtra : public LexerExtra { public:
     BSDModuleLexerExtra() { }
-    void require(String, ErrorHandler *);
+    void require(String type, String value, ErrorHandler *errh);
 };
 
 void
-BSDModuleLexerExtra::require(String r, ErrorHandler *errh)
+BSDModuleLexerExtra::require(String type, String value, ErrorHandler *errh)
 {
-    if (!click_has_provision(r.c_str()))
-	errh->error("unsatisfied requirement `%s'", r.c_str());
+    if (type.equals("package", 7) && !click_has_provision(value.c_str()))
+	errh->error("unsatisfied requirement %<%s%>", value.c_str());
 }
 
 static Router *

doc/click.5

@@ -515,15 +515,15 @@ elementclass Test { $a, $b | /* nothing */ || ... }
 .SH "REQUIREMENTS"
 '
 A configuration can say that it depends on optional packages by using the
-`require' statement. Its argument is a comma-separated list of package
-names:
+`require' statement. Its argument is a comma-separated list of require
+statements, such as package names:
 .Rs
-require(fastclassifier, specialcode);
+require(package fastclassifier, package specialcode);
 .Re
 Installation programs can use the package names to find and upload any
-necessary package code. Furthermore, the required package names are checked
-against a list of currently active packages when a configuration is
-installed. If any required packages are unavailable, an error is reported.
+necessary package code. The required package names are also checked against
+a list of currently active packages when a configuration is installed. If
+any required packages are unavailable, an error is reported.
 '
 .SH "PARAMETER DEFINITIONS"
 '

etc/samplepackage/test.click

@@ -1,4 +1,4 @@
-require(sample);
+require(package "sample");
 
 test :: SamplePackageElement;
 

include/click/lexer.hh

@@ -192,7 +192,7 @@ class LexerExtra { public:
     LexerExtra()			{ }
     virtual ~LexerExtra()		{ }
 
-    virtual void require(String, ErrorHandler *);
+    virtual void require(String type, String value, ErrorHandler *errh);
 
 };
 

include/click/router.hh

@@ -118,8 +118,7 @@ class Router { public:
     inline void use();
     void unuse();
 
-    inline const Vector<String>& requirements() const;
-    void add_requirement(const String& requirement);
+    void add_requirement(const String &type, const String &value);
     int add_element(Element *e, const String &name, const String &conf, const String &filename, unsigned lineno);
     int add_connection(int from_idx, int from_port, int to_idx, int to_port);
 #if CLICK_LINUXMODULE
@@ -426,12 +425,6 @@ Router::root_element() const
     return _root_element;
 }
 
-inline const Vector<String>&
-Router::requirements() const
-{
-    return _requirements;
-}
-
 inline ThreadSched*
 Router::thread_sched() const
 {

lib/driver.cc

@@ -354,20 +354,20 @@ namespace {
 
 class RequireLexerExtra : public LexerExtra { public:
     RequireLexerExtra(const Vector<ArchiveElement> *a) : _archive(a) { }
-    void require(String, ErrorHandler *);
+    void require(String type, String value, ErrorHandler *errh);
   private:
     const Vector<ArchiveElement> *_archive;
 };
 
 void
-RequireLexerExtra::require(String name, ErrorHandler *errh)
+RequireLexerExtra::require(String type, String value, ErrorHandler *errh)
 {
 # ifdef HAVE_DYNAMIC_LINKING
-    if (!click_has_provision(name.c_str()))
-	clickdl_load_requirement(name, _archive, errh);
+    if (type.equals("package", 7) && !click_has_provision(value.c_str()))
+	clickdl_load_requirement(value, _archive, errh);
 # endif
-    if (!click_has_provision(name.c_str()))
-	errh->error("requirement %<%s%> not available", name.c_str());
+    if (type.equals("package", 7) && !click_has_provision(value.c_str()))
+	errh->error("requirement %<%s%> not available", value.c_str());
 }
 
 }

lib/lexer.cc

@@ -8,6 +8,7 @@
  * Copyright (c) 2001-2003 International Computer Science Institute
  * Copyright (c) 2004-2007 Regents of the University of California
  * Copyright (c) 2008 Meraki, Inc.
+ * Copyright (c) 2010 Intel Corporation
  *
  * Permission is hereby granted, free of charge, to any person obtaining a
  * copy of this software and associated documentation files (the "Software"),
@@ -1471,34 +1472,51 @@ Lexer::ycompound(String name)
 void
 Lexer::yrequire()
 {
-  if (expect('(')) {
+    if (!expect('('))
+	return;
+
     String requirement = lex_config();
     expect(')');
     // pre-read ';' to make it easier to write parsing extensions
     expect(';', false);
 
     Vector<String> args;
-    String word;
     cp_argvec(requirement, args);
+
+    String compact_config_str = String::make_stable("compact_config", 14);
+    String package_str = String::make_stable("package", 7);
+
     for (int i = 0; i < args.size(); i++) {
-      Vector<String> words;
-      cp_spacevec(args[i], words);
-      if (words.size() == 0)
-	/* do nothing */;
-      else if (!cp_word(words[0], &word))
-	lerror("bad requirement: not a word");
-      else if (words.size() > 1)
-	lerror("bad requirement: too many words");
-      else {
-	if (word.equals("compact_config", 14)) {
+	Vector<String> words;
+	cp_spacevec(args[i], words);
+	if (words.size() == 0)
+	    continue;		// do nothing
+
+	String type, value;
+	(void) cp_word(words[0], &type);
+	// "require(UNKNOWN)" means "require(package UNKNOWN)"
+	if (type && type != compact_config_str && type != package_str
+	    && words.size() == 1) {
+	    words.push_back(type);
+	    type = package_str;
+	}
+
+	if (type == compact_config_str && words.size() == 1) {
 	    _compact_config = true;
-	    word = word.compact();
-	} else if (_lextra)
-	    _lextra->require(word, _errh);
-	_requirements.push_back(word);
-      }
+	    type = compact_config_str;
+	} else if (type == package_str && words.size() == 2
+		   && cp_string(words[1], &value))
+	    /* OK */;
+	else {
+	    lerror("syntax error at requirement");
+	    continue;
+	}
+
+	if (_lextra)
+	    _lextra->require(type, value, _errh);
+	_requirements.push_back(type);
+	_requirements.push_back(value);
     }
-  }
 }
 
 void
@@ -1712,8 +1730,8 @@ Lexer::create_router(Master *master)
       router->add_connection((*cp)[1].idx, (*cp)[1].port, (*cp)[0].idx, (*cp)[0].port);
 
   // add requirements to router
-  for (int i = 0; i < _requirements.size(); i++)
-    router->add_requirement(_requirements[i]);
+  for (int i = 0; i < _requirements.size(); i += 2)
+      router->add_requirement(_requirements[i], _requirements[i+1]);
 
   return router;
 }
@@ -1724,7 +1742,7 @@ Lexer::create_router(Master *master)
 //
 
 void
-LexerExtra::require(String, ErrorHandler *)
+LexerExtra::require(String, String, ErrorHandler *)
 {
 }
 

lib/router.cc

@@ -428,11 +428,12 @@ Router::add_connection(int from_idx, int from_port, int to_idx, int to_port)
 }
 
 void
-Router::add_requirement(const String &r)
+Router::add_requirement(const String &type, const String &requirement)
 {
-    assert(cp_is_word(r));
-    _requirements.push_back(r);
-    if (r.equals("compact_config", 14)) {
+    assert(cp_is_word(type));
+    _requirements.push_back(type);
+    _requirements.push_back(requirement);
+    if (type.equals("compact_config", 14)) {
 	_have_configuration = false;
 	_configuration = String();
     }
@@ -1890,8 +1891,15 @@ void
 Router::unparse_requirements(StringAccum &sa, const String &indent) const
 {
     // requirements
-    if (_requirements.size())
-	sa << indent << "require(" << cp_unargvec(_requirements) << ");\n\n";
+    if (_requirements.size()) {
+	sa << indent << "require(";
+	for (int i = 0; i < _requirements.size(); i += 2) {
+	    sa << (i ? ", " : "") << _requirements[i];
+	    if (_requirements[i+1])
+		sa << " " << cp_quote(_requirements[i+1]);
+	}
+	sa << ");\n\n";
+    }
 }
 
 /** @brief Unparse declarations of the router's elements into @a sa.

linuxmodule/config.cc

@@ -66,14 +66,14 @@ read_classes(Element *, void *)
 
 class LinuxModuleLexerExtra : public LexerExtra { public:
     LinuxModuleLexerExtra() { }
-    void require(String, ErrorHandler *);
+    void require(String type, String value, ErrorHandler *errh);
 };
 
 void
-LinuxModuleLexerExtra::require(String r, ErrorHandler *errh)
+LinuxModuleLexerExtra::require(String type, String value, ErrorHandler *errh)
 {
-    if (!click_has_provision(r.c_str()))
-	errh->error("unsatisfied requirement '%s'", r.c_str());
+    if (type.equals("package", 7) && !click_has_provision(value.c_str()))
+	errh->error("unsatisfied requirement %<%s%>", value.c_str());
 }
 
 static Router *

tools/click-devirtualize/click-devirtualize.cc

@@ -166,10 +166,11 @@ reverse_transformation(RouterT *r, ErrorHandler *)
 
   // remove requirements
   {
-    Vector<String> requirements = r->requirements();
-    for (int i = 0; i < requirements.size(); i++)
-      if (requirements[i].substring(0, 12) == "devirtualize")
-	r->remove_requirement(requirements[i]);
+      Vector<String> requirements = r->requirements();
+      for (int i = 0; i < requirements.size(); i += 2)
+	  if (requirements[i].equals("package", 7)
+	      && requirements[i+1].substring(0, 12) == "devirtualize")
+	      r->remove_requirement(requirements[i], requirements[i+1]);
   }
 
   // remove archive elements
@@ -441,7 +442,7 @@ particular purpose.\n");
       md5_free(&pms);
       package_name = "clickdv_" + String(buf, buflen);
   }
-  router->add_requirement(package_name);
+  router->add_requirement("package", package_name);
 
   // output
   StringAccum header, source;

tools/click-fastclassifier/click-fastclassifier.cc

@@ -369,8 +369,8 @@ classifiers_program(RouterT *r, const Vector<ElementT *> &classifiers)
 
     ElementT *idle = nr->add_anon_element(ElementClassT::base_type("Idle"));
     const Vector<String> &old_requirements = r->requirements();
-    for (int i = 0; i < old_requirements.size(); i++)
-	nr->add_requirement(old_requirements[i]);
+    for (int i = 0; i < old_requirements.size(); i += 2)
+	nr->add_requirement(old_requirements[i], old_requirements[i+1]);
 
     // copy AlignmentInfos and AddressInfos
     copy_elements(r, nr, ElementClassT::base_type("AlignmentInfo"));
@@ -633,7 +633,7 @@ compile_classifiers(RouterT *r, const String &package_name,
     analyze_classifiers(nr, classifiers, errh);
 
     // add requirement
-    r->add_requirement(package_name);
+    r->add_requirement("package", package_name);
 
     // write Classifier programs
     for (int i = 0; i < all_programs.size(); i++)
@@ -758,10 +758,11 @@ reverse_transformation(RouterT *r, ErrorHandler *)
 
   // remove requirements
   {
-    Vector<String> requirements = r->requirements();
-    for (int i = 0; i < requirements.size(); i++)
-      if (requirements[i].substring(0, 14) == "fastclassifier")
-	r->remove_requirement(requirements[i]);
+      Vector<String> requirements = r->requirements();
+      for (int i = 0; i < requirements.size(); i += 2)
+	  if (requirements[i].equals("package", 7)
+	      && requirements[i+1].substring(0, 14) == "fastclassifier")
+	      r->remove_requirement(requirements[i], requirements[i+1]);
   }
 
   // remove archive elements

tools/click-install/click-install.cc

@@ -158,12 +158,15 @@ static void
 compile_archive_packages(RouterT *r, HashTable<String, int> &packages,
 			 ErrorHandler *errh)
 {
-  Vector<String> requirements = r->requirements();
   bool tmpdir_populated = false;
 
   // go over requirements
-  for (int i = 0; i < requirements.size(); i++) {
-    const String &req = requirements[i];
+  Vector<String> requirements = r->requirements();
+  for (int i = 0; i < requirements.size(); i += 2) {
+    if (!requirements[i].equals("package", 7))
+      continue;
+
+    const String &req = requirements[i+1];
 
     // skip if already have object file
     if (r->archive_index(req + OBJSUFFIX) >= 0
@@ -221,11 +224,13 @@ install_required_packages(RouterT *r, HashTable<String, int> &packages,
   // check for uncompiled archive packages and try to compile them
   compile_archive_packages(r, packages, errh);
 
+  // go over requirements
   Vector<String> requirements = r->requirements();
+  for (int i = 0; i < requirements.size(); i += 2) {
+    if (!requirements[i].equals("package", 7))
+	continue;
 
-  // go over requirements
-  for (int i = 0; i < requirements.size(); i++) {
-    String req = requirements[i];
+    String req = requirements[i+1];
 
     // look for object in archive
     int obj_aei = r->archive_index(req + OBJSUFFIX);

tools/lib/elementmap.cc

@@ -644,8 +644,11 @@ ElementMap::parse_requirement_files(RouterT *r, const String &default_path, Erro
 
     // parse elementmaps for requirements in required order
     const Vector<String> &requirements = r->requirements();
-    for (int i = 0; i < requirements.size(); i++) {
-	String req = requirements[i];
+    for (int i = 0; i < requirements.size(); i += 2) {
+	if (!requirements[i].equals("package", 7))
+	    continue;
+
+	String req = requirements[i+1];
 	String mapname = "elementmap-" + req + ".xml";
 	String mapname2 = "elementmap." + req;