Bug#24488219: INCLUDE WHAT YOU USE

Make only one canonical place to get LEX_STRING from. We had this typedef
repeated a number of times throughout the code base, which would cause
IWYU to pick a random one and include e.g. sql_class.h into client code.

Change-Id: I5fb63ff4d02c3ae3c1913957bf70df287f9f2289

Author: Steinar H. Gunderson

client/mysql.cc

@@ -46,6 +46,7 @@
 #include <violite.h>
 
 #include "client_priv.h"
+#include "lex_string.h"
 #include "my_compiler.h"
 #include "my_dbug.h"
 #include "my_default.h"

include/lex_string.h

@@ -0,0 +1,31 @@
+/*
+   Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
+
+   This program is free software; you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation; version 2 of the License.
+
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with this program; if not, write to the Free Software
+   Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA */
+
+#ifndef LEX_STRING_INCLUDED
+#define LEX_STRING_INCLUDED
+
+#include "mysql/mysql_lex_string.h"
+
+/*
+  LEX_STRING -- a pair of a C-string and its length.
+  (it's part of the plugin API as a MYSQL_LEX_STRING)
+  Ditto LEX_CSTRING/MYSQL_LEX_CSTRING.
+*/
+
+typedef struct st_mysql_lex_string LEX_STRING;
+typedef struct st_mysql_const_lex_string LEX_CSTRING;
+
+#endif

include/m_string.h

@@ -26,6 +26,7 @@
 #include <stdlib.h>
 #include <string.h>
 
+#include "lex_string.h"
 #include "my_byteorder.h"    /* uint8korr */
 #include "my_config.h"
 #include "my_dbug.h"
@@ -336,20 +337,10 @@ static inline char *ullstr(longlong value, char *buff)
 }
 #endif
 
-/*
-  LEX_STRING -- a pair of a C-string and its length.
-  (it's part of the plugin API as a MYSQL_LEX_STRING)
-  Ditto LEX_CSTRING/MYSQL_LEX_CSTRING.
-*/
-
-typedef struct st_mysql_lex_string LEX_STRING;
-typedef struct st_mysql_const_lex_string LEX_CSTRING;
-
 #define STRING_WITH_LEN(X) (X), ((sizeof(X) - 1))
 #define USTRING_WITH_LEN(X) ((uchar*) X), ((sizeof(X) - 1))
 #define C_STRING_WITH_LEN(X) ((char *) (X)), ((sizeof(X) - 1))
 
-
 /**
   Skip trailing space.
 

include/sql_string.h

@@ -26,6 +26,7 @@
 #include <sys/types.h>
 #include <new>
 
+#include "lex_string.h"
 #include "m_ctype.h"                         // my_convert
 #include "m_string.h"                        // LEX_CSTRING
 #include "mem_root_fwd.h"
@@ -39,9 +40,6 @@
 #include "mysql/psi/psi_memory.h"
 #include "mysql/service_mysql_alloc.h"       // my_free
 
-typedef struct st_mysql_lex_string LEX_STRING;
-
-
 #ifdef MYSQL_SERVER
 extern "C" {
 extern PSI_memory_key key_memory_String_value;

plugin/audit_null/audit_null.c

@@ -22,6 +22,7 @@
 #include <stdio.h>
 #include <sys/types.h>
 
+#include "lex_string.h"
 #include "my_compiler.h"
 #include "my_inttypes.h"
 #include "my_macros.h"

plugin/version_token/version_token.cc

@@ -27,6 +27,7 @@
 #include <sys/types.h>
 #include <sstream>
 
+#include "lex_string.h"
 #include "my_compiler.h"
 #include "my_dbug.h"
 #include "my_inttypes.h"

rapid/plugin/group_replication/src/sql_service/sql_service_interface.cc

@@ -17,6 +17,7 @@
 
 #include <stddef.h>
 
+#include "lex_string.h"
 #include "my_dbug.h"
 #include "plugin_log.h"
 

sql-common/client.cc

@@ -47,6 +47,7 @@
 
 #include "errmsg.h"
 #include "hash.h"
+#include "lex_string.h"
 #include "my_compiler.h"
 #include "my_dbug.h"
 #include "my_default.h"

sql/auth/auth_common.h

@@ -25,6 +25,7 @@
 #include <vector>
 
 #include "auth_acls.h"                          /* ACL information */
+#include "lex_string.h"
 #include "m_string.h"
 #include "my_command.h"
 #include "my_dbug.h"

sql/auth/role_tables.cc

@@ -22,6 +22,7 @@
 #include "field.h"
 #include "handler.h"
 #include "key.h"
+#include "lex_string.h"
 #include "m_string.h"
 #include "mdl.h"
 #include "my_base.h"

sql/auth/sql_auth_cache.h

@@ -25,6 +25,7 @@
 #include "handler.h"
 #include "hash.h"                       // HASH
 #include "key.h"
+#include "lex_string.h"
 #include "lf.h"
 #include "mf_wcomp.h"                   // wild_many, wild_one, wild_prefix
 #include "my_atomic.h"

sql/auth/sql_authentication.h

@@ -1,4 +1,4 @@
-/* Copyright (c) 2000, 2016, Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2000, 2017, Oracle and/or its affiliates. All rights reserved.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -16,10 +16,12 @@
 #ifndef SQL_AUTHENTICATION_INCLUDED
 #define SQL_AUTHENTICATION_INCLUDED
 
+#include "my_config.h"
+
 #include <sys/types.h>
 
+#include "lex_string.h"
 #include "m_ctype.h"
-#include "my_config.h"
 #include "my_thread_local.h"            // my_thread_id
 #include "mysql/plugin.h"
 #include "mysql/plugin_auth.h"          // MYSQL_SERVER_AUTH_INFO

sql/auth/sql_authorization.cc

@@ -44,6 +44,7 @@
 #include "item.h"
 #include "key.h"
 #include "key_spec.h"                   /* Key_spec */
+#include "lex_string.h"
 #include "log.h"                        /* sql_print_warning */
 #include "m_ctype.h"
 #include "m_string.h"

sql/auth/sql_security_ctx.h

@@ -21,6 +21,7 @@
 #include <algorithm>
 
 #include "auth/auth_common.h"
+#include "lex_string.h"
 #include "m_string.h"
 #include "my_dbug.h"
 #include "my_sharedlib.h"

sql/auth/sql_user.cc

@@ -21,6 +21,7 @@
 #include "handler.h"
 #include "hash.h"
 #include "item.h"
+#include "lex_string.h"
 #include "log_event.h"                  /* append_query_string */
 #include "m_ctype.h"
 #include "m_string.h"

sql/auth/sql_user_table.cc

@@ -36,6 +36,7 @@
 #include "hash.h"
 #include "item_func.h"                  /* mqh_used */
 #include "key.h"                        /* key_copy, key_cmp_if_same */
+#include "lex_string.h"
                                         /* key_restore */
 #include "log.h"                        /* sql_print_warning */
 #include "m_ctype.h"

sql/binlog.cc

@@ -26,6 +26,7 @@
 #include <stdlib.h>
 #include <sys/stat.h>
 
+#include "lex_string.h"
 #include "my_macros.h"
 #include "my_systime.h"
 #ifdef HAVE_UNISTD_H

sql/bootstrap.cc

@@ -25,6 +25,7 @@
 
 #include "bootstrap_impl.h"
 #include "error_handler.h"       // Internal_error_handler
+#include "lex_string.h"
 #include "log.h"                 // sql_print_warning
 #include "m_string.h"
 #include "my_dbug.h"

sql/conn_handler/init_net_server_extension.cc

@@ -19,6 +19,7 @@
 
 #include <stddef.h>
 
+#include "lex_string.h"
 #include "my_dbug.h"
 #include "my_inttypes.h"
 #include "mysql/psi/mysql_idle.h"       // MYSQL_SOCKET_SET_STATE,

sql/dd/dd_event.cc

@@ -21,6 +21,7 @@
 #include "dd/types/schema.h"
 #include "event_parse_data.h"   // Event_parse_data
 #include "key.h"
+#include "lex_string.h"
 #include "log.h"                // sql_print_error
 #include "my_dbug.h"
 #include "my_sys.h"

sql/dd/dd_routine.cc

@@ -34,6 +34,7 @@
 #include "dd/types/view.h"
 #include "field.h"
 #include "key.h"
+#include "lex_string.h"
 #include "my_dbug.h"
 #include "my_decimal.h"
 #include "my_inttypes.h"

sql/dd/dd_table.cc

@@ -48,6 +48,7 @@
 #include "item.h"
 #include "key.h"
 #include "key_spec.h"
+#include "lex_string.h"
 #include "log.h"                              // sql_print_error
 #include "m_ctype.h"
 #include "m_string.h"

sql/dd/dd_tablespace.cc

@@ -32,6 +32,7 @@
 #include "dd/types/tablespace.h"              // dd::Tablespace
 #include "dd/types/tablespace_file.h"         // dd::Tablespace_file
 #include "handler.h"
+#include "lex_string.h"
 #include "my_dbug.h"
 #include "my_inttypes.h"
 #include "my_io.h"

sql/dd/dd_trigger.h

@@ -1,5 +1,5 @@
 /*
-   Copyright (c) 2016, Oracle and/or its affiliates. All rights reserved.
+   Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -16,11 +16,11 @@
 #ifndef DD_TRIGGER_INCLUDED
 #define DD_TRIGGER_INCLUDED
 
+#include "dd/string_type.h"  // dd::String_type
+#include "lex_string.h"
 #include "m_string.h"        // LEX_CSTRING
 #include "trigger_def.h"     // enum_trigger_order_type
 
-#include "dd/string_type.h"  // dd::String_type
-
 class THD;
 class Trigger;
 typedef struct st_mem_root MEM_ROOT;

sql/dd/dd_upgrade.cc

@@ -40,6 +40,7 @@
 #include "event_db_repository.h"              // Events
 #include "event_parse_data.h"                 // Event_parse_data
 #include "handler.h"                          // legacy_db_type
+#include "lex_string.h"
 #include "lock.h"                             // Tablespace_hash_set
 #include "log.h"                              // sql_print_warning
 #include "my_dbug.h"

sql/dd/dd_view.cc

@@ -39,6 +39,7 @@
 #include "item.h"
 #include "item_func.h"                        // Item_func
 #include "key.h"
+#include "lex_string.h"
 #include "log.h"                              // sql_print_error, sql_print_..
 #include "mdl.h"
 #include "my_dbug.h"

sql/dd/impl/bootstrapper.cc

@@ -52,6 +52,7 @@
 #include "dd/types/view.h"                    // dd::View
 #include "error_handler.h"                    // No_such_table_error_handler
 #include "handler.h"                          // dict_init_mode_t
+#include "lex_string.h"
 #include "log.h"                              // sql_print_warning()
 #include "m_ctype.h"
 #include "m_string.h"                         // STRING_WITH_LEN

sql/dd/impl/cache/dictionary_client.cc

@@ -65,6 +65,7 @@
 #include "dd/types/view_table.h"             // View_table
 #include "debug_sync.h"                      // DEBUG_SYNC()
 #include "handler.h"
+#include "lex_string.h"
 #include "log.h"                             // sql_print_warning()
 #include "m_ctype.h"
 #include "m_string.h"

sql/dd/impl/dictionary_impl.h

@@ -25,6 +25,7 @@
 #include "dd/dictionary.h"           // dd::Dictionary
 #include "dd/object_id.h"            // dd::Object_id
 #include "dd/string_type.h"          // dd::String_type
+#include "lex_string.h"
 #include "m_string.h"
 #include "table.h"                   // MYSQL_SCHEMA_NAME
 

sql/dd/impl/properties_impl.h

@@ -23,6 +23,7 @@
 
 #include "dd/properties.h"         // dd::Properties
 #include "dd/string_type.h"        // dd::String_type
+#include "lex_string.h"
 #include "m_string.h"
 #include "my_dbug.h"
 #include "my_inttypes.h"

sql/dd/impl/sdi_file.cc

@@ -31,6 +31,7 @@
 #include "dd/types/schema.h"        // dd::Schema
 #include "dd/types/table.h"         // dd::Table
 #include "handler.h"
+#include "lex_string.h"
 #include "m_ctype.h"
 #include "my_dbug.h"
 #include "my_inttypes.h"

sql/dd/impl/system_registry.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2014, 2017 Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2014, 2017, Oracle and/or its affiliates. All rights reserved.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -44,6 +44,7 @@
 #include "dd/impl/tables/version.h"                  // Version
 #include "dd/impl/tables/view_routine_usage.h"       // View_routine_usage
 #include "dd/impl/tables/view_table_usage.h"         // View_table_usage
+#include "lex_string.h"
 #include "m_string.h"
 #include "table.h"                                   // MYSQL_SYSTEM_SCHEMA
 

sql/dd/impl/types/event_impl.cc

@@ -23,11 +23,12 @@
 #include "dd/impl/transaction_impl.h"            // Open_dictionary_tables_ctx
 #include "dd/string_type.h"                      // dd::String_type
 #include "dd/types/weak_object.h"
-#include "mysql_com.h"
-#include "mysqld_error.h"                        // ER_*
-#include "mysqld.h"
+#include "lex_string.h"
 #include "my_sys.h"
 #include "my_user.h"                             // parse_user
+#include "mysql_com.h"
+#include "mysqld.h"
+#include "mysqld_error.h"                        // ER_*
 
 using dd::tables::Events;
 

sql/dd/impl/types/routine_impl.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -27,11 +27,12 @@
 #include "dd/string_type.h"                      // dd::String_type
 #include "dd/types/parameter.h"
 #include "dd/types/weak_object.h"
-#include "mysql_com.h"
-#include "mysqld_error.h"
-#include "mysqld.h"
+#include "lex_string.h"
 #include "my_sys.h"
 #include "my_user.h"                             // parse_user
+#include "mysql_com.h"
+#include "mysqld.h"
+#include "mysqld_error.h"
 
 using dd::tables::Routines;
 using dd::tables::Parameters;

sql/dd/impl/types/trigger_impl.cc

@@ -1,4 +1,4 @@
-/* Copyright (c) 2016 Oracle and/or its affiliates. All rights reserved.
+/* Copyright (c) 2016, 2017, Oracle and/or its affiliates. All rights reserved.
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
@@ -24,10 +24,11 @@
 #include "dd/string_type.h"                      // dd::String_type
 #include "dd/types/object_table.h"
 #include "dd/types/weak_object.h"
-#include "mysql_com.h"
-#include "mysqld_error.h"                        // ER_*
+#include "lex_string.h"
 #include "my_sys.h"
 #include "my_user.h"                             // parse_user
+#include "mysql_com.h"
+#include "mysqld_error.h"                        // ER_*
 #include "sql_class.h"
 
 using dd::tables::Triggers;