File indexing completed on 2024-12-08 07:18:26

 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 from __future__ import print_function, unicode_literals
 #
 #   This file is part of the KDE project
 #   Copyright (C) 2010-2015 Jarosław Staniek <staniek@kde.org>
 #
 #   Shared Data Compiler (SDC)
 
 version = '0.3'
 
 #   A tool that takes a header file with C++ class declaration with specification
 #   of class' data members and injects getters, setters and facilities for
 #   Qt 5-compatible implicitly/explicitly sharing. Tedious, manual work is considerably
 #   reduced. The generated code is enriched with Doxygen-style documentation.
 #
 #   Syntax:
 #    Add an //SDC: comment to the class declaration line
 #        class MYLIB_EXPORT MyClass [: public SuperClass] //SDC: [CLASS_OPTIONS]
 #
 #    supported CLASS_OPTIONS: namespace=NAMESPACE, with_from_to_map,
 #                             operator==, explicit, virtual_dtor, custom_clone
 #
 #    TODO: explain details in README-SDC.md
 #
 #    Specification of each class' data members should be in form:
 #
 #        TYPE NAME; //SDC: [DATA_MEMBER_OPTIONS]
 #
 #    Supported DATA_MEMBER_OPTIONS: default=DEFAULT_VALUE, no_getter, no_setter,
 #                                   getter=CUSTOM_GETTER_NAME,
 #                                   setter=CUSTOM_SETTER_NAME,
 #                                   custom, custom_getter, custom_setter,
 #                                   default_setter=DEFAULT_SETTER_PARAM,
 #                                   mutable, simple_type, invokable,
 #                                   internal, custom_clone
 #    If NAME contains '(' then 'TYPE NAME;' is added to the shared data class
 #    as a method declaration.
 #
 #   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; either
 #   version 2 of the License, or (at your option) any later version.
 #
 #   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
 #   Library General Public License for more details.
 #
 #   You should have received a copy of the GNU Library General Public License
 #   along with this program; see the file COPYING.  If not, write to
 #   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 #   Boston, MA 02110-1301, USA.
 #
 #   As a special exception, you may create a larger work that contains
 #   code generated by the Shared Data Compiler and distribute that work
 #   under terms of the GNU Lesser General Public License (LGPL) as published
 #   by the Free Software Foundation; either version 2.1 of the License,
 #   or (at your option) any later version or under terms that are fully
 #   compatible with these licenses.
 #
 #   Alternatively, if you modify or redistribute the Shared Data Compiler tool
 #   itself, you may (at your option) remove this special exception, which will
 #   cause the resulting generted source code files to be licensed under
 #   the GNU General Public License (either version 2 of the License, or
 #   at your option under any later version) without this special exception.
 #
 #   This special exception was added by Jarosław Staniek.
 #   Contact him for more licensing options, e.g. using in non-Open Source projects.
 #
 
 import os, sys, shlex
 
 line = ''
 
 APPNAME = "Shared Data Compiler"
 
 def usage():
     print('''Usage: %s [INPUT] [OUTPUT]
 %s version %s
 ''' % (sys.argv[0], APPNAME, version))
 
 def syntax_error(msg):
     print(APPNAME, "Syntax error in %s: %s" % (in_fname, msg), file=sys.stderr)
     sys.exit(1)
 
 def warning(*objs):
     print(APPNAME, "WARNING:", *objs, file=sys.stderr)
 
 if len(sys.argv) < 3:
     usage()
     sys.exit(0)
 
 # --- open ---
 in_fname = sys.argv[1]
 out_fname = sys.argv[2]
 
 try:
     infile = open(in_fname, "rb") # binary mode needed for Windows
     outfile = open(out_fname, "wb")
 except Exception as inst:
     print(inst)
     sys.exit(1)
 
 outfile_sdc = None
 
 # --- utils ---
 def write(f, line):
     f.write(line.encode('utf-8'))
 
 def param(lst, name):
     for item in lst:
         s = item.split('=')
         if len(s) > 1 and s[0] == name:
             return s[1]
     return ''
 
 def param_exists(lst, name):
     try:
         if lst.index(name) >= 0:
             return True
     except ValueError:
             pass
     return False
 
 def find_index(list, elem):
     try:
         i = list.index(elem)
     except ValueError:
         i = -1
     return i
 
 def find_last_index(list, elem):
     i = find_index(list[::-1], elem) #reverted
     return -1 if i == -1 else len(list) - i - 1
 
 # --- process ---
 shared_class_name = ''
 shared_class_options = {}
 generated_code_inserted = False
 shared_class_inserted = False
 data_class_ctor = ''
 data_class_copy_ctor = ''
 data_class_members = ''
 members_list = []
 data_accesors = ''
 protected_data_accesors = ''
 main_ctor = ''
 member = {}
 toMap_impl = ''
 fromMap_impl = ''
 
 def get_file(fname):
     if fname.rfind(os.sep) == -1:
         return fname
     return fname[fname.rfind(os.sep)+1:]
 
 def open_sdc():
     global outfile_sdc, shared_class_options
     if not outfile_sdc:
         sdc_fname = out_fname.replace('.h', '_sdc.cpp')
         try:
             outfile_sdc = open(sdc_fname, "wb")
         except Exception as inst:
             print(inst)
             sys.exit(1)
     write(outfile_sdc, warningHeader())
     write(outfile_sdc, """#include "%s"
 #include <QVariant>
 
 """ % get_file(out_fname))
 
     if shared_class_options['namespace']:
         write(outfile_sdc, """using namespace %s;
 
 """ % shared_class_options['namespace'])
 
 """
     Inserts generated fromMap(), toMap() code into the output.
     Declarations are inserted into the header, definitions into extra *_sdc.cpp file
 """
 def insert_fromMap_toMap_methods():
     global outfile, shared_class_name, toMap_impl, fromMap_impl
     write(outfile, """    /*! @return map with saved attributes of the %s object.
 
      @see %s(const QMap<QString, QString>&, bool *).
     */
     QMap<QString, QString> toMap() const {
         return d->toMap();
     }
 
 """ % (shared_class_name, shared_class_name))
     open_sdc()
     write(outfile_sdc, """%s::Data::Data(const QMap<QString, QString> &map, bool *ok)
 {
     if (ok) {
         *ok = true;
     }
 %s}
 
 QMap<QString, QString> %s::Data::toMap() const
 {
     QMap<QString, QString> map;
 %s    return map;
 }
 """ % (shared_class_name, fromMap_impl, shared_class_name, toMap_impl))
     outfile_sdc.close()
 
 """
     Inserts generated operator==() code for shared class into the output.
 """
 def insert_operator_eq():
     global outfile, shared_class_name, shared_class_options, superclass
     data = 'data()' if superclass else 'd'
     otherData = 'other.' + data
     if not shared_class_options['explicit']: # deep comparison only for implicitly shared data
         data = '*' + data
         otherData = '*' + otherData
     write(outfile, """    //! @return true if this object is equal to @a other; otherwise returns false.
     bool operator==(const %s &other) const {
         return %s == %s;
     }
 
 """ % (shared_class_name, data, otherData))
 
 """
     Inserts generated operator!=() code for shared class into the output.
 """
 def insert_operator_neq():
     global outfile, shared_class_name, shared_class_options, superclass
     write(outfile, """    //! @return true if this object is not equal to @a other; otherwise returns false.
     bool operator!=(const %s &other) const {
         return !operator==(other);
     }
 
 """ % (shared_class_name))
 
 """
     Prepends 'virtual' to the method if there is superclass, otherwise appends 'override'.
 """
 def virtual_or_override(hasSuperclass, method):
     return ('virtual ' if not hasSuperclass else '') + method + (' override' if hasSuperclass else '')
 
 """
     Inserts generated clone() method (makes sense for explicitly shared class).
 """
 def insert_clone():
     global outfile, shared_class_name, shared_class_options, superclass
     line = """    //! Clones the object with all attributes; the copy isn't shared with the original.
     %s""" % virtual_or_override(superclass, shared_class_name + ' clone() const')
     custom_clone = False; # not needed I guess: shared_class_options['custom_clone']
     if custom_clone:
         line += """;
 """
     else:
         line += """ {
         return %s(d->clone());
     }
 """ % (shared_class_name)
     write(outfile, line)
 
 """
     Inserts generated Data::operator==() code into the output.
 """
 def insert_data_operator_eq():
     global outfile, members_list, superclass
     write(outfile, """        bool operator==(const Data &other) const {
 """)
     write(outfile, "            return ")
     first = True;
     space = """
                    && """
     if superclass:
         write(outfile, '%s::Data::operator==(other)' % superclass)
         first = False;
     for member in members_list:
         if member['internal']:
             continue
         write(outfile, """%s%s == other.%s""" % ('' if first else space, member['name'], member['name']))
         if first:
             first = False
     write(outfile, """;
         }
 
 """)
 
 """
     Inserts generated code into the output.
 """
 def insert_generated_code(context):
     global infile, outfile, generated_code_inserted, data_class_ctor, data_class_copy_ctor, superclass
     global data_class_members, data_accesors, protected_data_accesors, main_ctor, shared_class_name, shared_class_options
     global prev_line
     if generated_code_inserted:
         return;
     #print "--------insert_generated_code--------"
     #write(outfile, '//CONTEXT:' + str(context) + '\n')
     #write(outfile, '//data_class_ctor>\n')
     write(outfile, data_class_ctor)
     #write(outfile, '//<data_class_ctor\n')
     write(outfile,"""        {
         }
 """)
     write(outfile, data_class_copy_ctor)
     write(outfile, """        {
         }
 
 """)
     write(outfile, """        %s {}
 
 """ % virtual_or_override(superclass, '~Data()'))
     write(outfile, """        //! Clones the object with all attributes; the copy isn't shared with the original.
         %s""" % virtual_or_override(superclass, ((superclass + '::') if superclass else '') + "Data* clone() const"))
     if shared_class_options['custom_clone']:
         write(outfile, """;
 
 """)
     else:
         write(outfile, """ { return new Data(*this); }
 
 """)
 
     if shared_class_options['with_from_to_map']:
         write(outfile, """        /*! Constructor for Data object, takes attributes saved to map @a map.
         If @a ok is not 0, *ok is set to true on success and to false on failure. @see toMap(). */
         Data(const QMap<QString, QString> &map, bool *ok);
 
         QMap<QString, QString> toMap() const;
 
 """)
     if shared_class_options['operator=='] and not shared_class_options['explicit']:
         insert_data_operator_eq()
 
     write(outfile, data_class_members)
     write(outfile, main_ctor)
     write(outfile, data_accesors)
     write(outfile, "\n")
     if shared_class_options['with_from_to_map']:
         insert_fromMap_toMap_methods()
     if shared_class_options['operator==']:
         insert_operator_eq()
         insert_operator_neq()
     if shared_class_options['explicit'] and (not superclass or shared_class_options['custom_clone']):
         insert_clone()
     if protected_data_accesors:
         write(outfile, "protected:")
         write(outfile, protected_data_accesors)
         write(outfile, "\npublic:")
     write(outfile, "\n")
     generated_code_inserted = True
 
 
 """
     Reads documentation for single section (setter or getter) and returns it.
     Leaves the file pointer before */ or another @getter/@setter mark.
 """
 def read_getter_or_setter_doc():
     global prev_line, line
     result = ''
     while True:
         prev_pos = infile.tell()
         prev_line = line
         line = infile.readline().decode('utf-8')
         if not line:
             break
         elif line.find('*/') != -1 or line.find('@getter') != -1 or line.find('@setter') != -1:
             #print "seek prev from " + line
             infile.seek(prev_pos)
             break
         else:
             result += line
     return result
 
 def process_docs(comment):
     global prev_line, line
     result = {}
     while True:
         prev_line = line
         line = infile.readline().decode('utf-8')
         #print "process_docs: " + line
         if not line:
             break
         elif line.find('*/') != -1:
             if result == {}:
                 insert_generated_code(1)
                 write(outfile, line)
             break
         elif line.find('@getter') != -1:
             result['getter'] = read_getter_or_setter_doc()
         elif line.find('@setter') != -1:
             result['setter'] = read_getter_or_setter_doc()
         else:
             insert_generated_code(2)
             write(outfile, comment)
             write(outfile, line)
     if result == {}:
         result = None
     #print "process_docs result: " + str(result)
     return result
 
 def try_read_member_docs(comment):
     global prev_line, line
     prev_pos = infile.tell()
     result = comment
     while True:
         prev_line = line
         line = infile.readline().decode('utf-8')
         if not line or line.find('@getter') != -1 or line.find('@setter') != -1:
             infile.seek(prev_pos)
             return None
         elif line.find('*/') != -1:
             return result
         else:
             result += line
     return None
 
 """ makes setter out of name or returns forceSetter if specified """
 def makeSetter(name, forceSetter):
     if forceSetter:
         return forceSetter
     return 'set' + name[0].upper() + name[1:]
 
 def update_data_accesors():
     global data_accesors, protected_data_accesors, member
     if not member['no_getter']:
         if 'getter_docs' in member:
             val = '\n    /*!\n' + member['getter_docs'] + '    */'
             if member['access'] == 'public':
                 data_accesors += val
             else: # protected
                 protected_data_accesors += val
         getter = member['getter']
         if not getter:
             getter = member['name']
         invokable = 'Q_INVOKABLE ' if member['invokable'] else ''
         if member['custom_getter']:
             val = """
     %s%s %s() const;
 """ % (invokable, member['type'], getter)
         else:
             val = """
     %s%s %s() const {
         return %s->%s;
     }
 """ % (invokable, member['type'], getter, 'data()' if superclass else 'd', member['name'])
         if member['access'] == 'public':
             data_accesors += val
         else: # protected
             protected_data_accesors += val
     if not member['no_setter']:
         if 'setter_docs' in member:
             val = '\n    /*!\n' + member['setter_docs'] + '    */'
             if member['access'] == 'public':
                 data_accesors += val
             else: # protected
                 protected_data_accesors += val
         # heuristics to check if the const & should be used:
         arg_type = member['type']
         if arg_type.lower() != arg_type and not member['simple_type']:
             arg_type = 'const %s &' % arg_type
         setter = makeSetter(member['name'], member['setter'])
         default_setter = (' = ' + member['default_setter']) if member['default_setter'] else ''
         invokable = 'Q_INVOKABLE ' if member['invokable'] else ''
         if member['custom_setter']:
             val = """
     %svoid %s(%s %s%s);
 """ % (invokable, setter, arg_type, member['name'], default_setter)
         else:
             val = """
     %svoid %s(%s %s%s) {
         %s->%s = %s;
     }
 """ % (invokable, setter, arg_type, member['name'], default_setter, 'data()' if superclass else 'd', member['name'], member['name'])
         if member['access'] == 'public':
             data_accesors += val
         else: # protected
             protected_data_accesors += val
 
 def data_member_found(lst):
     return len(lst) > 2 and lst[0] != 'class' and find_index(lst, '//SDC:') >= 2
 
 # sets shared_class_options[option_name] to proper value; returns lst with removed element option_name if exists
 def get_shared_class_option(lst, option_name):
     global shared_class_options
     shared_class_options[option_name] = param_exists(lst, option_name)
     if shared_class_options[option_name]:
         lst.remove(option_name)
     return lst
 
 """ like get_shared_class_option() but also gets value (not just checks for existence) """
 def get_shared_class_option_with_value(lst, option_name):
     global shared_class_options
     for item in lst:
         s = item.split('=')
         if len(s) > 1 and s[0] == option_name:
             lst.remove(item)
             shared_class_options[option_name] = s[1]
             return lst
     shared_class_options[option_name] = False
     return lst
 
 def enabled_shared_class_options():
     global shared_class_options
     result = []
     for opt in shared_class_options:
         if shared_class_options[opt]:
             result.append(opt)
     # add some defaults
     if find_index(result, 'explicit') == -1:
         result.append('implicit')
     return result
 
 def warningHeader():
     return """/****************************************************************************
 ** Shared Class code from reading file '%s'
 **
 ** Created
 **      by: The Shared Data Compiler version %s
 **
 ** WARNING! All changes made in this file will be lost!
 *****************************************************************************/
 
 """ % (get_file(in_fname), version)
 
 """ generates conversion code to string from many types, used by Data::toMap()
     @todo more types """
 def generate_toString_conversion(name, _type):
     if _type == 'QString' or _type == 'QByteArray':
         return name
     elif _type == 'bool':
         return 'QString::number((int)%s)' % name # 0 or 1
     return 'QVariant(%s).toString()' % name
 
 """ generates conversion code from string to many types, used by Data(QMap<..>)
     @todo more types """
 def generate_fromString_conversion(name, _type):
     s = 'map[QLatin1String(\"%s\")]' % name
     if _type == 'bool': # 0 or 1
         return """bool %sOk;
     %s = %s.toInt(&%sOk) == 1;
     if (!%sOk && ok) {
         *ok = false;
     }""" % (name, name, s, name, name)
     elif _type == 'int':
         return """bool %sOk;
     %s = %s.toInt(&%sOk);
     if (!%sOk && ok) {
         *ok = false;
     }""" % (name, name, s, name, name)
     else: # QString...
         return "%s = %s;" % (name, s)
 
 # returns position (line number) for #include <QSharedData> or -1 if #include <QSharedData> isn't needed
 def get_pos_for_QSharedData_h():
     global infile, prev_line, line
     prev_pos = infile.tell()
     line_number = -1
     infile.seek(0)
     # find last #include
     last_include = -1
     while True:
         prev_line = line
         line = infile.readline().decode('utf-8').lower()
         if not line:
             break
         line_number += 1
         if line.find('#include ') != -1:
             if line.find('qshareddata') != -1:
                 last_include = -1
                 break
             else:
                 last_include = line_number + 1
     infile.seek(prev_pos)
     return last_include
 
 # replaces "Foo<ABC<DEF>>" with "Foo< ABC< DEF > >" to avoid build errors
 def fix_templates(s):
     if s.count('<') < 2:
         return s
     result=''
     for c in s:
         if c == '>':
             result += ' '
         result += c
         if c == '<':
             result += ' '
     return result
 
 def other_comment(line):
     ln = line.strip(' ')
     return ln.startswith('/**') \
       or ln.startswith('/*!') \
       or ln .startswith('//!') \
       or ln.startswith('///')
 
 """ @return (shared_class_name, export_macro, superclass) """
 def get_shared_class_name_export_and_superclass(lst):
     # if 'lst' contains ':' and then 'public', we have inheritance
     i = find_last_index(lst, 'public') # last index because there can be multiple 'public/protected' and most likely we want the last
     #print i
     if i >= 3:
         inheritance_type = 'public'
     else:
         i = find_last_index(lst, 'protected')
         inheritance_type = 'protected' if i >= 3 else ''
     # - if there's inheritance and export_macro exists, lst has at least 6 elements:
     # ['class', export_macro, shared_class_name, ':', 'public/protected', superclass, ...]:
     # - if export_macro exists, lst has at least 3 elements:
     # ['class', export_macro, shared_class_name, ...]:
     expected_len = 6 if inheritance_type else 3
     if len(lst) >= expected_len:
         _shared_class_name = lst[2]
         _export_macro = lst[1]
     else: # no export_macro
         _shared_class_name = lst[1]
         _export_macro = ''
     _superclass = lst[i + 1] if inheritance_type else ''
     return (_shared_class_name, _export_macro, _superclass)
 
 """ Strips the C++ comment //: @return lst with removed first found element that starts
     with '//' and all following """
 def remove_cpp_comment(lst):
     result = []
     for el in lst:
         if el.startswith('//'):
             break
         result.append(el)
     return result
 
 """ Simplifies a multi-line doc like this:
 /*!
 Foo
 */
 to:
 /*! Foo */ """
 def simplify_multiline_doc(doc):
     lines = doc.split('\n')
     result = []
     if lines[0].strip() == '':
         result += '\n'
         lines.pop(0)
     if len(lines) < 2:
         return doc
     indentation = '';
     i = 0;
     for c in lines[0]:
         if c == ' ' or c == '\t':
             indentation += c
         else:
             break
     line0 = lines[0].strip()
     line1 = lines[1].strip()
     if line0 == '/*!' and not line1.startswith('/*') and not line1.startswith('/*'):
         result += indentation + '/*! ' + line1 + '\n'
         lines = lines[2:] # because line 0 and 1 already processed
     for line in lines:
         if line.strip() == '*/': # add to prev line
             last = result.pop()
             result += last[:-1] + ' */\n'
         else:
             result += line + '\n'
     result[-1] = result[-1][:-1] # remove last \n
     return ''.join(result)
 
 def process():
     global infile, outfile, generated_code_inserted, data_class_ctor, data_class_copy_ctor
     global shared_class_name, superclass, shared_class_options, shared_class_inserted, data_class_members
     global members_list, data_accesors, member, main_ctor, toMap_impl, fromMap_impl
     global prev_line, line
     write(outfile, warningHeader())
 
     member = {}
     after_member = False
 
     data_class_ctor = ''
     data_class_copy_ctor = ''
     data_class_ctor_changed = False
     data_class_copy_ctor_changed = False
     position_for_include_QSharedData_h = get_pos_for_QSharedData_h()
 
     line_number = -1 # used for writing #include <QSharedData>
     while True:
         prev_line = line
         line = infile.readline().decode('utf-8')
         line_number += 1
         if not line:
             break
 #        print line,
         lst = line.split()
         #print lst, find_index(lst, '//SDC:')
         if line_number == position_for_include_QSharedData_h:
             write(outfile, """#include <QSharedData>
 """)
             position_for_include_QSharedData_h = -1
         line_starts_with_class = len(lst) > 0 and lst[0] == 'class'
         if line_starts_with_class and find_index(lst, '//SDC:') < 0:
             shared_class_inserted = False # required because otherwise QSharedDataPointer<Data> d will be added to all classes
             write(outfile, line)
         elif line_starts_with_class and find_index(lst, '//SDC:') > 0:
             # re-init variables, needed if there are more than one shared class per file
             shared_class_inserted = False
             generated_code_inserted = False
             shared_class_options = {}
             data_class_ctor = ''
             data_class_copy_ctor = ''
             data_class_members = ''
             members_list = []
             data_accesors = ''
             protected_data_accesors = ''
             toMap_impl = ''
             fromMap_impl = ''
             data_class_ctor_changed = False
             data_class_copy_ctor_changed = False
             lst = shlex.split(line) # better than default split()
             # Syntax: shared class [EXPORT_MACRO] [CLASS_OPTIONS] MyClass [: public SuperClass]
             # Any unrecognized bits are left out, this lets to use EXPORT_MACRO=MYLIB_EXPORT for example.
             # output: class [EXPORT_MACRO] MyClass [: public SuperClass]
             lst = get_shared_class_option(lst, 'explicit')
             lst = get_shared_class_option(lst, 'operator==')
             lst = get_shared_class_option(lst, 'with_from_to_map')
             lst = get_shared_class_option(lst, 'virtual_dtor')
             lst = get_shared_class_option(lst, 'custom_clone') # only insert declaration of clone()
             lst = get_shared_class_option_with_value(lst, 'namespace')
             (shared_class_name, export_macro, superclass) = get_shared_class_name_export_and_superclass(lst)
             if superclass:
                 shared_class_options['virtual_dtor'] = True # inheritance implies this
             if shared_class_options['custom_clone'] and not shared_class_options['explicit']:
                 warning('\'custom_clone\' class option only supported with \'explicit\' class option')
                 shared_class_options['custom_clone'] = False
             main_ctor = """    };
 
     %s()
      : %s(new Data)
     {
     }
 
     %s(const %s &other)
      : %s
     {
     }
 """ % (shared_class_name, superclass if superclass else 'd', shared_class_name, shared_class_name, (superclass + '(other)') if superclass else 'd(other.d)')
             if superclass:
                 main_ctor += """
     %s(const %s &other)
      : %s(other)
     {
         if (!data()) { // '@a 'other' does not store suitable data, create a new one and copy what we have
             d = new Data(*d.data());
         }
     }
 """ % (shared_class_name, superclass, superclass)
 
             if shared_class_options['with_from_to_map']:
                 main_ctor += """
     /*! Constructor for %s object, takes attributes saved to map @a map.
          If @a ok is not 0, sets *ok to true on success and to false on failure. @see toMap(). */
     %s(const QMap<QString, QString> &map, bool *ok)
      : d(new Data(map, ok))
     {
     }
 """ % (shared_class_name, shared_class_name)
             main_ctor += """
     %s;
 """ % virtual_or_override(superclass and shared_class_options['virtual_dtor'], '~' + shared_class_name + '()')
             if shared_class_options['explicit']:
                 write(outfile, """/*! @note objects of this class are explicitly shared, what means they behave like regular
           C++ pointers, except that by doing reference counting and not deleting the shared
           data object until the reference count is 0, they avoid the dangling pointer problem.
           See <a href="https://doc.qt.io/qt-5/qexplicitlyshareddatapointer.html#details">Qt documentation</a>.
  */
 """)
             else:
                 write(outfile, """/*! @note objects of this class are implicitly shared, what means they have value semantics
           by offering copy-on-write behaviour to maximize resource usage and minimize copying.
           Only a pointer to the data is passed around. See <a href="https://doc.qt.io/qt-5/qshareddatapointer.html#details">Qt documentation</a>.
  */
 """)
 
             # Finally output the class name: use all remaining elements of 'lst' except
             # the 0th (which is the 'shared' keyword):
             write(outfile, '//! @note This class has been generated using the following SDC class options: '
                           + ', '.join(enabled_shared_class_options()) + '\n')
             write(outfile, ' '.join(remove_cpp_comment(lst)) + '\n')
             while True:
                 prev_line = line
                 line = infile.readline().decode('utf-8')  # output everything until 'public:'
                 write(outfile, line)
                 if line.strip().startswith('public:'):
                     break
             shared_class_inserted = True
         elif len(lst) >= 2 and lst[0] == '#if' and lst[1] == '0':
             insert_generated_code(3)
             write(outfile, line)
             while True:
                 prev_line = line
                 line = infile.readline().decode('utf-8') 
                 lst = line.split()
                 if not line:
                     break
                 elif len(lst) >= 1 and lst[0] == '#endif':
                     write(outfile, line)
                     break
                 write(outfile, line)
         elif len(lst) == 1 and (lst[0] == '/**' or lst[0] == '/*!'):
             comment = line
 
             member_docs = try_read_member_docs(comment)
             #print "member_docs:" + str(member_docs)
 
             docs = None
             if member_docs:
                 member = {}
                 member['docs'] = '\n    ' + member_docs.replace('\n', '\n    ') + '    */';
             else:
                 docs = process_docs(comment)
             if docs:
                 #print "DOCS:" + str(docs)
                 member = {}
                 if 'getter' in docs:
                     member['getter_docs'] = docs['getter']
                 if 'setter' in docs:
                     member['setter_docs'] = docs['setter']
             elif not member_docs:
                 insert_generated_code(4)
                 write(outfile, comment)
         elif len(lst) >= 2 and lst[0] == 'enum':
             # skip enums: until '};' found
             write(outfile, line)
             while True:
                 prev_line = line
                 line = infile.readline().decode('utf-8')
                 lst = line.split()
                 if len(lst) > 0 and lst[0] == '};':
                     write(outfile, line)
                     break
                 write(outfile, line)
         elif data_member_found(lst):
             """ for syntax see top of the file """
             if lst[1].endswith(';'):
                 lst[1] = lst[1][:-1] # strip ';' from member name
             sdc_index = find_index(lst, '//SDC:')
             options_list = lst[sdc_index+1:]
             #print lst
             member['name'] = lst[1]
             member['type'] = fix_templates(lst[0])
             member['access'] = 'protected' if (find_index(options_list, 'protected') >= 0) else 'public'
             member['default'] = param(options_list, 'default')
             member['default_setter'] = param(options_list, 'default_setter')
             member['internal'] = param_exists(options_list, 'internal'); # skip Data::operators and setter/getter
             member['no_getter'] = param_exists(options_list, 'no_getter') or member['internal']
             member['getter'] = param(options_list, 'getter')
             member['no_setter'] = param_exists(options_list, 'no_setter') or member['internal']
             member['setter'] = param(options_list, 'setter')
             member['custom'] = param_exists(options_list, 'custom')
             member['custom_getter'] = param_exists(options_list, 'custom_getter') or member['custom']
             member['custom_setter'] = param_exists(options_list, 'custom_setter') or member['custom']
             member['mutable'] = param_exists(options_list, 'mutable')
             member['simple_type'] = param_exists(options_list, 'simple_type')
             member['invokable'] = param_exists(options_list, 'invokable')
             # '(' found in name so it's a method declaration -> just add it to the data class
             isMethodDeclaration = find_index(member['name'], '(') >= 0
             isInternalMember = member['no_getter'] and member['no_setter']
             #print member
             if not data_class_ctor_changed:
                 data_class_ctor = """    //! @internal data class used to implement %s shared class %s.
     //! Provides thread-safe reference counting.
     class Data : public %s
     {
     public:
         Data()
 """ % ('explicitly' if shared_class_options['explicit'] else 'implicitly', shared_class_name, (superclass + '::Data') if superclass else 'QSharedData')
             if not data_class_copy_ctor_changed:
                 data_class_copy_ctor = ''
                 if superclass:
                     data_class_copy_ctor += """
         Data(const %s::Data &other)
          : %s::Data(other)
         {
         }
 """ % (superclass, superclass)
                 data_class_copy_ctor += """
         Data(const Data &other)
          : %s(other)
 """ % ((superclass + '::Data') if superclass else 'QSharedData')
                 data_class_copy_ctor_changed = True
             if not isMethodDeclaration:
                 members_list.append(member);
                 if member['default']:
                     data_class_ctor += '        '
                     if data_class_ctor_changed:
                         data_class_ctor += ', '
                     else:
                         data_class_ctor += ': '
                         data_class_ctor_changed = True
                     data_class_ctor += member['name'] + '(' + member['default'] + ')\n'
     #            print data_class_ctor
                 if not member['internal']:
                     data_class_copy_ctor += '         , %s(other.%s)\n' % (member['name'], member['name'])
             if 'docs' in member:
                 data_class_members += simplify_multiline_doc(member['docs']) + '\n';
 
             mutable = 'mutable ' if member['mutable'] else ''
             data_class_members += "        %s%s;" % (mutable, ' '.join(lst[:sdc_index]))
             # add doc for shared data member
             if not isMethodDeclaration:
                 if isInternalMember:
                     data_class_members += ' //!< @internal'
                 else:
                     data_class_members += ' //!< @see '
                 if not member['no_getter']:
                     getter = member['getter']
                     if not getter:
                         getter = member['name']
                     data_class_members += "%s::%s()" % (shared_class_name, getter)
                 if not member['no_setter']:
                     if not member['no_getter']:
                         data_class_members += ", "
                     setter = makeSetter(member['name'], member['setter'])
                     data_class_members += "%s::%s()" % (shared_class_name, setter)
 
             data_class_members += '\n'
 
             if not isMethodDeclaration:
                 if shared_class_options['with_from_to_map']:
                     toMap_impl += '    map[QLatin1String(\"%s\")] = %s;\n' % (member['name'], generate_toString_conversion(member['name'], member['type']))
                     fromMap_impl += '    %s\n' % generate_fromString_conversion(member['name'], member['type'])
                 update_data_accesors()
 
             member = {}
             if len(prev_line.split()) == 0: # remove current line because it's not going to the output now; this helps to remove duplicated empty lines
                 line = ''
             after_member = True
         elif len(lst) > 0 and lst[0] == '};' and line[:2] == '};' and shared_class_inserted:
             insert_generated_code(5)
 #            write(outfile, '\nprivate:\n');
             write(outfile, '\nprotected:\n');
             if shared_class_options['explicit']:
                 if superclass:
                     write(outfile, """    virtual const Data* data() const { return dynamic_cast<const Data*>(%s::d.constData()); }
     virtual Data* data() { return dynamic_cast<Data*>(%s::d.data()); }
 """ % (superclass, superclass))
                 else:
                     write(outfile, """    %s(Data *data)
      : d(data)
     {
     }
 
     %s(QExplicitlySharedDataPointer<%s::Data> &data)
      : d(data)
     {
     }
 
     QExplicitlySharedDataPointer<Data> d;
 """ % (shared_class_name, shared_class_name, shared_class_name))
             else:
                 write(outfile, '    QSharedDataPointer<Data> d;\n');
             write(outfile, line)
 
             if shared_class_options['explicit']:
                 write(outfile, """
 template<>
 %s %s::Data *QSharedDataPointer<%s::Data>::clone();
 """ % (export_macro, shared_class_name, shared_class_name))
                 open_sdc()
                 write(outfile_sdc, """template<>
 %s %s::Data *QSharedDataPointer<%s::Data>::clone()
 {
     return d->clone();
 }
 """ % (export_macro, shared_class_name, shared_class_name))
 
         else:
             #write(outfile, '____ELSE____\n');
             if False and other_comment(line):
                 prev_pos = infile.tell()
                 prev_line_number = line_number
                 ln = line[:-1].strip(' ')
                 result = ''
                 print("'" + ln + "'")
                 if ln.startswith('/**') or ln.startswith('/*!'):
                     while True:
                         result += line
                         if not line or ln.endswith('*/'):
                             result = result[:-1]
                             break
                         prev_line = line
                         line = infile.readline().decode('utf-8')
                         line_number += 1
                         ln = line[:-1].strip(' ')
                     print(result)
                 if result:
                     member['docs'] = result
                 infile.seek(prev_pos)
                 prev_line = line
                 line = infile.readline().decode('utf-8')
                 lst = line.split()
                 line_number = prev_line_number
 
             if not lst:
                 if len(prev_line.split()) > 0:
                     #write(outfile, '['+prev_line + ']prev_line[' + line +']')
                     write(outfile, line)
             elif not after_member or len(lst) > 0:
                 if shared_class_inserted:
                     insert_generated_code(6)
                 write(outfile, line)
             elif generated_code_inserted and len(lst) == 0:
                 #write(outfile, 'ELSE>>>' + line)
                 write(outfile, line)
 #            else:
 #                write(outfile, line)
 
 process()
 
 # --- close ---
 infile.close()
 outfile.close()