Cppcheck report - CGM: src/geom/RefEntityName.cpp

#include "RefEntityName.hpp"
#include "CubitString.hpp"
#include "RefEntity.hpp"
#include "CubitMessage.hpp"
#include "CubitUtil.hpp"
#include "CastTo.hpp"
#include "RefGroup.hpp"
#include "CubitAttribUser.hpp"
#include "CADefines.hpp"
#include <algorithm>

#include "SettingHandler.hpp"

#include <ctype.h>
#include <assert.h>

// template needed to sort CubitStrings

template <> struct DLIListSorter<CubitString>
{
  bool operator()(const CubitString &a, const CubitString &b) { return a < b; }
};


RefEntityName* RefEntityName::instance_ = 0;
CubitBoolean RefEntityName::mergeBaseNames = CUBIT_FALSE;
int RefEntityName::generateDefaultNames = CUBIT_FALSE;
int RefEntityName::fixDuplicateNames = CUBIT_TRUE;
char RefEntityName::suffixCharacter = '@';
char RefEntityName::replacementCharacter = '_';
static int is_valid_char(char c);
static int is_valid_first_char(char c);
bool RefEntityName::printNameChangeWarnings = true;
int RefEntityName::numNameChangeWarnings = 0;
 
RefEntityName* RefEntityName::instance()
{
  if (instance_ == 0) {
    instance_ = new RefEntityName;
  }
  return instance_;
}

RefEntityName::RefEntityName()
{
  generateDefaultNames = CUBIT_FALSE;
  fixDuplicateNames = CUBIT_TRUE;
  replacementCharacter = '_';
  suffixCharacter = '@';
}

RefEntityName::~RefEntityName()
{
  instance_ = 0;
}

void RefEntityName::remove_refentity_name(RefEntity* entity,
                                          const CubitString &name,
                                          CubitBoolean update_attribs)
{
  std::pair<RefEntityNameMap::iterator, RefEntityNameMap::iterator> iters = nameEntityList.refMap.equal_range(entity);
  std::map<CubitString, RefEntity*>::iterator jter = nameEntityList.nameMap.find(name);

  bool changed = false;
  for(;iters.first != iters.second; ++iters.first)
  {
    if(iters.first->second == name)
    {
      changed = true;
      nameEntityList.refMap.erase(iters.first);
      break;
    }
  }
  
  if( nameEntityList.nameMap.end() != jter && jter->second == entity)
  {
    changed = true;
    nameEntityList.nameMap.erase(jter);    
  }  

    // tell the ref entity to update its names
  if (changed && update_attribs)
  {
    CubitAttrib *attrib = entity->get_cubit_attrib(CA_ENTITY_NAME);
    attrib->has_updated(CUBIT_FALSE);
    attrib->update();
    if( attrib->delete_attrib() )
      entity->remove_cubit_attrib( attrib );
  }
}

void RefEntityName::remove_refentity_name(RefEntity *entity,
                                          CubitBoolean update_attribs)
{
  //update the attribute so the names are put into the entity list
  if (update_attribs)
  {
    CubitAttrib *attrib = entity->get_cubit_attrib(CA_ENTITY_NAME,
                                                   CUBIT_FALSE);
    if (attrib) 
    {
      //update the attribute so that the names are on it.
      attrib->has_written( CUBIT_FALSE );
      attrib->has_updated(CUBIT_FALSE);
      attrib->update();

      //remove the attribute from the underlying entity
      //of the solid modeling kernel
      RefEntity *attrib_owner = attrib->attrib_owner();
      attrib_owner->remove_attrib_geometry_entity( attrib );
    }
  }

    // NOTE: There may be multiple names for one RefEntity. Make sure to 
    //       remove all of them. 
  
  std::pair<RefEntityNameMap::iterator, RefEntityNameMap::iterator> iters = nameEntityList.refMap.equal_range(entity);

  for(; iters.first != iters.second;)
  {
    CubitString name = iters.first->second;

    std::map<CubitString, RefEntity*>::iterator jter = nameEntityList.nameMap.find( name );

    if(nameEntityList.nameMap.end() != jter && jter->second == entity)
    {
      nameEntityList.nameMap.erase(jter);
    }

    nameEntityList.refMap.erase(iters.first++);
  }

    // now tell the entity to update its name attribute
  if (update_attribs)
  {
    CubitAttrib *attrib = entity->get_cubit_attrib(CA_ENTITY_NAME,
                                                   CUBIT_FALSE);
    if (attrib) 
    {
      attrib->has_updated(CUBIT_FALSE);
      attrib->update();
      entity->remove_cubit_attrib( attrib );
      delete attrib;
    }
  }
}

CubitStatus RefEntityName::add_refentity_name(RefEntity *entity,
                                              DLIList<CubitString> &names,
                                              bool update_attribs, 
                                              bool check_name_validity)
{
  names.reset();
  //int num_new_names = names.size();

  DLIList<CubitString> new_names;
  
  for (int i=0; i<names.size(); i++)
  {
    CubitString name = names[i];
    CubitString in_name = name;
    CubitBoolean warn_name_change = CUBIT_FALSE;
    
      // first, clean the name
    if (check_name_validity)
    {
      if (clean(name))
      {
        // assign original name anyway, then
        // continue on and assign modified name.
        add_refentity_name(entity, in_name, false, false);
        warn_name_change = CUBIT_TRUE;
      }
    }
      // now, check for valid name
    CubitBoolean name_valid = CUBIT_FALSE;

    std::map<CubitString, RefEntity*>::iterator jter;
    jter = nameEntityList.nameMap.find( name );    
    bool name_exist = nameEntityList.nameMap.end() != jter;
    
    if (name == "")
    {
        // blank name entered - do nothing
    }
    
    else if( name_exist && jter->second == entity )
    {
        // Tried to assign same name to entity
      if ( DEBUG_FLAG(92) ) 
      {
          // check to see if it's the same as this entity's default name,
          // if so, it probably came in on an attribute, and we don't need
          // to hear about it; otherwise, write the warning
        CubitString def_name;
        entity->generate_default_name(def_name);
        if (name != def_name)
          PRINT_INFO("Entity name '%s' already assigned to %s %d\n",
                     name.c_str(), 
                     entity->class_name(), entity->id());
      }
    }
    else if(name_exist)
    {
        // Tried to assign existing name to another entity
      PRINT_DEBUG_92( "Entity name '%s' for %s %d is already used by %s %d\n",
                  name.c_str(), entity->class_name(), entity->id(),
                  jter->second->class_name(),
                  jter->second->id());
      
        // either we fix it and keep it, or we don't and get rid of it
      name_valid = CUBIT_FALSE;
      if (get_fix_duplicate_names())
      {
        //if the entity already has the base name, don't generate another
        DLIList<CubitString> tmp_names;
        get_refentity_name( entity, tmp_names );
        bool gen_unique_name = true;
        for( int k=0; k<tmp_names.size(); k++ )
        {
          CubitString tmp_name = tmp_names[k];
          if( same_base_name( name, tmp_name ) )
          {
            gen_unique_name = false;
            break;
          }
        }

        if (gen_unique_name && generate_unique_name(name) )
        {
          PRINT_DEBUG_92( "\t%s %d name changed to '%s'\n",
                          entity->class_name(), entity->id(), name.c_str());
          if(warn_name_change)
          {
            numNameChangeWarnings++;
            if(printNameChangeWarnings)
            {
              PRINT_WARNING("Entity name '%s' can't be used in commands.\n"
                   "         Additional name '%s' assigned.\n",
                in_name.c_str(), name.c_str());
            }
          }
          
          name_valid = CUBIT_TRUE;
        }
      }
    }
    else
    {
      if(warn_name_change)
      {
        numNameChangeWarnings++;
        if(printNameChangeWarnings)
        {
          PRINT_WARNING("Entity name '%s' can't be used in commands.\n"
            "         Additional name '%s' assigned.\n",
            in_name.c_str(), name.c_str());
        }
      }
      
        // else the name must be valid
      name_valid = CUBIT_TRUE;
    }
    
    if (name_valid == CUBIT_TRUE)
    {
        // name is valid
      if (name != in_name)
          // name was changed; change in name list too
        names[i] = name;

        // save this name to later
      new_names.append(names[i]);
    }
  }
  
  if (new_names.size() > 0)
  {
      // there are some valid, new names; add them, then update attribute
    new_names.reset();
    
    for (int i = new_names.size(); i > 0; i--)
    {
      CubitString name = new_names.get_and_step();
      
      std::map<CubitString, RefEntity*>::iterator jter;
      jter = nameEntityList.nameMap.find( name );    

      if( nameEntityList.nameMap.end() != jter && jter->second == entity )
      {
            PRINT_DEBUG_92("Already have name %s for %s %d.\n",
                           name.c_str(), entity->class_name(), entity->id());
      }
      else
      {
        nameEntityList.nameMap.insert(std::make_pair(name, entity));
        nameEntityList.refMap.insert(std::make_pair(entity, name));
      }
    }
    
    if (update_attribs == CUBIT_TRUE)
    {
        // now tell the entity to update its name attribute
      CubitAttrib *attrib = entity->get_cubit_attrib(CA_ENTITY_NAME);
        // force update by resetting update flag
      attrib->has_updated(CUBIT_FALSE);
      attrib->update();
    }
  }
  
  return CUBIT_SUCCESS;
}

CubitStatus RefEntityName::add_refentity_name(RefEntity *entity,
                                              CubitString &name,
                                              bool update_attribs,
                                              bool check_name_validity)
{
  if (name == "")
    return CUBIT_FAILURE;
  
  CubitString in_name = name;
  bool warn_name_change = false;
  
  if (check_name_validity)
  {
    if (clean(name))
    {
      // Assign the invalid name anyway, then continue on and
      // assign the modified name.
      add_refentity_name(entity, in_name, false, false);
      warn_name_change = true;
    }
  }
  
  std::map<CubitString, RefEntity*>::iterator jter;
  jter = nameEntityList.nameMap.find( name );

  if(nameEntityList.nameMap.end() != jter && jter->second == entity )
  {
      // Tried to assign same name to entity
    if ( DEBUG_FLAG(92) )
    {
      PRINT_INFO("Entity name '%s' already assigned to %s %d\n",
                 name.c_str(),
                 entity->class_name(), entity->id());
      return CUBIT_FAILURE;
    }
    return CUBIT_SUCCESS;
  }
  else if(nameEntityList.nameMap.end() != jter)
  {
      // Tried to assign existing name to another entity
    if ( DEBUG_FLAG(92) )
      PRINT_WARNING("Entity name '%s' for %s %d is already used by %s %d\n",
                    name.c_str(),
                    entity->class_name(), entity->id(),
                    jter->second->class_name(), jter->second->id());
    if (get_fix_duplicate_names())
    {
      //if the entity already has the base name, don't generate another
      DLIList<CubitString> tmp_names;
      get_refentity_name( entity, tmp_names );
      bool gen_unique_name = true;
      for( int k=0; k<tmp_names.size(); k++ )
      {
        CubitString tmp_name = tmp_names[k];
        if( same_base_name( name, tmp_name ) )
        {
          gen_unique_name = false;
          break;
        }
      }

      if (gen_unique_name && generate_unique_name(name))
      {
        if (warn_name_change)
        {
          numNameChangeWarnings++;
          if(printNameChangeWarnings)
          {
            PRINT_WARNING("Entity name '%s' can't be used in commands.\n"
                 "         Additional name '%s' assigned.\n",
              in_name.c_str(), name.c_str());
          }
        }
        if ( DEBUG_FLAG(92) )
          PRINT_WARNING("\t%s %d name changed to '%s'\n",
          entity->class_name(), entity->id(), name.c_str());
        return add_refentity_name(entity, name, update_attribs, false);
      }
    }
    return CUBIT_FAILURE;
  }

  if (warn_name_change)
  {
    numNameChangeWarnings++;
    if(printNameChangeWarnings)
    {
      PRINT_WARNING("Entity name '%s' can't be used in commands.\n"
        "         Additional name '%s' assigned.\n",
        in_name.c_str(), name.c_str());
    }
  }

  nameEntityList.nameMap.insert(std::make_pair(name, entity));
  nameEntityList.refMap.insert(std::make_pair(entity, name));
  
  if (update_attribs == CUBIT_TRUE)
  {
      // now tell the entity to update its name attribute
    CubitAttrib *attrib = entity->get_cubit_attrib(CA_ENTITY_NAME);
      // force update by resetting update flag
    attrib->has_updated(CUBIT_FALSE);
    attrib->update();
  }
  
  return CUBIT_SUCCESS;
}

int RefEntityName::get_refentity_name(const RefEntity *entity,
                                      DLIList<CubitString> &names)
{
    // NOTE: There may be multiple names for one RefEntity. Make sure to 
    //       access all of them. 

  int num_names = 0;
  std::pair<RefEntityNameMap::iterator, RefEntityNameMap::iterator> iters = nameEntityList.refMap.equal_range(const_cast<RefEntity*>(entity));
  for(; iters.first != iters.second; ++iters.first)
  {
    num_names++;
    names.append(iters.first->second);
  }

  return num_names;
}

RefEntity*  RefEntityName::get_refentity(const CubitString &name) 
{
  NameRefEntityMap::iterator iter = nameEntityList.nameMap.find(name);
  if (iter != nameEntityList.nameMap.end())
  {
    return iter->second;
  }
  return NULL;
}

const char* RefEntityName::get_refentity_type(const CubitString &name)
{
  RefEntity *entity = get_refentity(name);
  if (entity != NULL) {
    return entity->class_name();
  } else {
    return NULL;
  }
}

int RefEntityName::get_refentity_id(const CubitString &name)
{
  RefEntity *entity = get_refentity(name);
  if (entity != NULL) {
    return entity->id();
  } else {
    return 0;
  }
}

void RefEntityName::merge_refentity_names(RefEntity *retained,
                                          RefEntity *dead)
{
  // NOTE: There may be multiple names for one RefEntity. Make sure to 
  //       process all of them.

  std::pair<RefEntityNameMap::iterator, RefEntityNameMap::iterator> iters = nameEntityList.refMap.equal_range(dead);
  if(iters.first == iters.second)
    return;

  std::pair<RefEntityNameMap::iterator, RefEntityNameMap::iterator> jters = nameEntityList.refMap.equal_range(retained);

  DLIList<CubitString> combined_names;
  for(RefEntityNameMap::iterator iter = jters.first; iter != jters.second; ++iter)
  {
    combined_names.append(iter->second);
  }
  for(RefEntityNameMap::iterator iter = iters.first; iter != iters.second; ++iter)
  {
    combined_names.append(iter->second);
  }
  combined_names.sort();

  remove_refentity_name(retained, false);
  remove_refentity_name(dead);

  if (get_merge_base_names() == CUBIT_TRUE)
  {
      // remove names with identical base names, keeping lowest
    for(int i=1; i<combined_names.size(); i++)
    {
      if(same_base_name(combined_names[i-1], combined_names[i]))
      {
        combined_names.remove();

      }
      combined_names.step();
    }
  }

  for(int i=0; i<combined_names.size(); i++)
  {
    nameEntityList.nameMap.insert(std::make_pair(combined_names[i], retained));
    nameEntityList.refMap.insert(std::make_pair(retained, combined_names[i]));
  }

    // now tell the entity to update its name attribute
  CubitAttrib *attrib = retained->get_cubit_attrib(CA_ENTITY_NAME);
    // force update by resetting update flag
  attrib->has_updated(CUBIT_FALSE);
  attrib->update();
}

void RefEntityName::switch_refentity_names(RefEntity *entity1,
                                           RefEntity *entity2)
{
  // NOTE: There may be multiple names for one RefEntity. Make sure to 
  //       process all of them. 

  DLIList<CubitString> names1, names2;
  get_refentity_name(entity1, names1);
  get_refentity_name(entity2, names2);

  remove_refentity_name(entity1, false);
  remove_refentity_name(entity2, false);

  add_refentity_name(entity1, names2, true, false);
  add_refentity_name(entity2, names1, true, false);
}

void RefEntityName::list_refentity_names(const char *type)
{
     // 'type' is a lowercase string specifying the type of entity to be
     // returned. (surface, body, ...)
     // if 'type' == "all", then all names will be listed.
   
   int do_all = (strcmp("all", type) == 0 || strlen(type) == 0);
   
   PRINT_INFO("\t______Name______  \t__Type__ Id\t\t_Propagated_\n");
   RefEntity *entity;
<--- The scope of the variable 'entity' can be reduced. [+]
The scope of the variable 'entity' can be reduced. Warning: Be careful when fixing this message, especially when there are inner loops. Here is an example where cppcheck will write that the scope for 'i' can be reduced:
void f(int x)
{
    int i = 0;
    if (x) {
        // it's safe to move 'int i = 0;' here
        for (int n = 0; n < 10; ++n) {
            // it is possible but not safe to move 'int i = 0;' here
            do_something(&i);
        }
    }
}
When you see this message it is always safe to reduce the variable scope 1 level.

   for(NameRefEntityMap::iterator iter = nameEntityList.nameMap.begin(); iter != nameEntityList.nameMap.end(); ++iter)
    {
       entity = iter->second;
       if (do_all || CubitUtil::strcmp_case_insensitive(entity->class_name(),
                                                     type) == 0)
    {
       PRINT_INFO("%24s  %8s\t%-10d \tNo\n", iter->first.c_str(),
                  entity->class_name(), entity->id());
       }
    }
}

int RefEntityName::get_generate_default_names()
{
  return generateDefaultNames;
}

void RefEntityName::set_generate_default_names(int on_off)
{
  generateDefaultNames = on_off;
}

int RefEntityName::get_fix_duplicate_names()
{
  return fixDuplicateNames;
}

void RefEntityName::set_fix_duplicate_names(int on_off)
{
  fixDuplicateNames = on_off;
}

CubitStatus RefEntityName::clean(CubitString &raw_name)
{
  if (raw_name == "")
    return CUBIT_FAILURE;

    // A valid name consists of alphanumeric characters plus '.', '_', '-', or '@'
  CubitStatus found_invalid_character = CUBIT_FAILURE;

  // Initial character must be alphabetic or "_".
  char c = raw_name.get_at(0);
  if (!is_valid_first_char(c)) {
    if (is_valid_first_char(get_character("replace")))
      raw_name.put_at(0, get_character("replace"));
    else
      raw_name.put_at(0, '_');
    found_invalid_character = CUBIT_SUCCESS;
  }
  
  for (unsigned int i = 1; i < raw_name.length(); i++) {
    c = raw_name.get_at(i);
    if (!is_valid_char(c)) {
      found_invalid_character = CUBIT_SUCCESS;
      raw_name.put_at(i, get_character("replace"));
    }
  }
  return found_invalid_character;
}

void RefEntityName::set_character(char rep, const CubitString &type)
{
  if (is_valid_char(rep)) {
    if (type.get_at(0) == 'R' || type.get_at(0) == 'r')
      replacementCharacter = rep;
    else if (type.get_at(0) == 'S' || type.get_at(0) == 's')
      suffixCharacter = rep;
    else
      PRINT_ERROR("Invalid character type '%s', must be "
		  "'replacement' or 'suffix'\n", type.c_str());
  } else {
    PRINT_ERROR("Character '%c' is not a valid entity name character\n",
		rep);
  }
}

char RefEntityName::get_character(const CubitString& type) const
{
  if (type.get_at(0) == 'R' || type.get_at(0) == 'r')
    return replacementCharacter;
  else if (type.get_at(0) == 'S' || type.get_at(0) == 's')
    return suffixCharacter;  
  else {
    PRINT_ERROR("Invalid character type '%s', must be "
		"'replacement' or 'suffix'\n", type.c_str());
    return '#';
  }
}

static int is_valid_char(char c)
{
  return (!isascii(c) || isalnum(c) || c == '.' || c == '_' || c == '@');
}

static int is_valid_first_char(char c)
{
  return (!isascii(c) || isalpha(c) || c == '_');
}

CubitStatus RefEntityName::generate_unique_name(CubitString &name )
{
  // The method used to generate a unique name is to append
  // 'suffixCharacter' and
  // a letter from A-Z, a-z, or 0-9 to the end of name.
  // If none of these produce a unique name, CUBIT_FALSE is returned.

  CubitString alphabet =
    "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
  CubitString suffix("  ");
  suffix.put_at(0, suffixCharacter);
  
  CubitString internal = name;

  // See if there is an suffixCharacter sign in name already. If so, is it
  // the second to the last character in the string.
  if (name.length() < 2 ||
      name.get_at(name.length()-2) != suffixCharacter) {
    // Name does not contain suffixCharacter at correct location, add one on.
    internal += suffix;
  }
  
  CubitStatus found_unique = CUBIT_FAILURE;
  int continue_trying = CUBIT_TRUE;

  while (!found_unique && continue_trying) {

    continue_trying = CUBIT_FALSE;
    int name_length = internal.length();
    unsigned int number_tested = 0;
    for (unsigned int i=0; i < alphabet.length(); i++) {
      internal.put_at(name_length-1, (char)alphabet.get_at(i));
      if (nameEntityList.nameMap.find(internal) == nameEntityList.nameMap.end())
      {
        found_unique = CUBIT_SUCCESS;
        break;
      }
      number_tested++;
    }

    if (number_tested == alphabet.length()) {
      // All suffixes used. Add another suffixCharacter and try again
      // Name will look like 'Name@@1' or 'Name@@@1'...
      // Find LAST suffixCharacter in name
      int ch;
      for (ch = (int)(internal.length())-1; ch >= 0; ch--) {
        if (internal.get_at(ch) == suffixCharacter) {
          break;
        }
      }
      if (internal.get_at(ch) == suffixCharacter) {
        // Add another suffixCharacter at ch+1
        // Assured that position ch+1 exists or we wouldn't be here
        internal.put_at(ch+1, suffixCharacter);
        if (ch+2 < (int)internal.length())
          internal.put_at(ch+2, ' ');
        else
          internal += " ";
        continue_trying = CUBIT_TRUE;
      }
    }
  }
  
  if (found_unique)
    name = internal;

  return found_unique;
}

CubitString RefEntityName::base_name(const CubitString& name)
{
  const char *pos = strchr(name.c_str(), suffixCharacter);
  if (!pos)
    return name;
  return name.substr(0, pos - name.c_str());
}


// returns CUBIT_TRUE if the two names have the same base name (i.e.
// the same name before the first suffixCharacter
CubitBoolean RefEntityName::same_base_name(const CubitString &name1,
                                           const CubitString &name2)
{
  const char *pos1 = strchr(name1.c_str(), suffixCharacter);
  const char *pos2 = strchr(name2.c_str(), suffixCharacter);

    // check for replacement character in one but not the other
  int length1, length2;
  if (pos1 == NULL)
    length1 = strlen(name1.c_str());
  else
    length1 = pos1 - name1.c_str();

  if (pos2 == NULL)
    length2 = strlen(name2.c_str());
  else
    length2 = pos2 - name2.c_str();

    // if the lengths are different, the base names are also different
  if (length1 != length2)
    return CUBIT_FALSE;

  if (strncmp(name1.c_str(), name2.c_str(), length1) == 0)
    return CUBIT_TRUE;
  else
    return CUBIT_FALSE;
}

// Copy names from one entity to another.  
// Added Aug.14,2000 by J.Kraftcheck for propogating
// names after virtual geometry operations.
void RefEntityName::copy_refentity_names( const RefEntity *source,
                                          RefEntity *target,
                                          CubitBoolean update_attribs )
{
  //No NULL pointers.
  assert( source && target );
  
  //If we can't have duplicate names, then it is not possible to 
  //copy names.
  if( ! get_fix_duplicate_names() ) return;
  
  //Assume the name is valid already, as it is attached to
  //the source entity.  Also, assume the name is unique to
  //the source entity.
  DLIList<CubitString> names;
  get_refentity_name( source, names );
  names.reset();
  
  //For each of the names on the source entity
  for( int i = names.size(); i > 0; i-- )
  {  
    CubitString name = names.get_and_step();
    //make the name unique
    generate_unique_name( name );
    //associate name with target

    nameEntityList.nameMap.insert( std::make_pair( name, target ) );
    nameEntityList.refMap.insert( std::make_pair( target, name ) );
  }
    
  if( (names.size() > 0) && (update_attribs == CUBIT_TRUE) )
  {
      // now tell the entity to update its name attribute
    CubitAttrib *attrib = target->get_cubit_attrib( CA_ENTITY_NAME );
      // force update by resetting update flag
    attrib->has_updated( CUBIT_FALSE );
    attrib->update();
  }
}



//Initialize all settings in this class
void RefEntityName::initialize_settings()
{

  SettingHandler::instance()->add_setting("Default Names", 
                                          RefEntityName::set_generate_default_names, 
					  RefEntityName::get_generate_default_names); 

  SettingHandler::instance()->add_setting("Fix Duplicate Names", 
                                          RefEntityName::set_fix_duplicate_names, 
					  RefEntityName::get_fix_duplicate_names);
   
  SettingHandler::instance()->add_setting("Replacement Character", 
					  RefEntityName::set_replacement_setting, 
					  RefEntityName::get_replacement_setting);  

  SettingHandler::instance()->add_setting("Suffix Character",
					  RefEntityName::set_suffix_setting,
					  RefEntityName::get_suffix_setting);

  SettingHandler::instance()->add_setting("Merge Base Names", 
                                          RefEntityName::set_merge_base_names, 
					  RefEntityName::get_merge_base_names); 

}


void RefEntityName::copy_refentity_names( DLIList<RefEntity*>& source_list,
                                          RefEntity* target,
                                          CubitBoolean unique_base_names,
                                          CubitBoolean update_attribs )
{
  //Validate input.
  assert( target != 0 );
  if( source_list.size() < 1 ) return;
  
  //If we can't have duplicate names, we can't copy.
  if( ! get_fix_duplicate_names() ) return;
  
  //If we need to ensure no duplicate base names...
  if( unique_base_names )
  {
    //Get a big list of all the names from the source_list
    DLIList<CubitString> name_list;
    source_list.reset();
    for( int i = source_list.size(); i > 0; i-- )
      get_refentity_name( source_list.get_and_step(), name_list );
      
    //If we don't have any names to add, we're done
    if( name_list.size() < 1 ) return;
    
    //Get the first name
    name_list.sort();
    name_list.reset();
    CubitString prev_key = name_list.get_and_step();
    
    //Add name to target
    CubitString name = prev_key;
    generate_unique_name( name );
    nameEntityList.nameMap.insert( std::make_pair( name, target ) );
    nameEntityList.refMap.insert( std::make_pair( target, name ) );
  
    //For the rest of the names...
    for( int j = name_list.size(); j > 1; j-- )
    {
      CubitString key_ptr = name_list.get_and_step();
      
      //If the name has a different base name than the previous, 
      //add it to the target.
      if( !same_base_name( prev_key, key_ptr ) )
      {
        name = key_ptr;
        generate_unique_name( name );
        nameEntityList.nameMap.insert( std::make_pair( name, target ) );
        nameEntityList.refMap.insert( std::make_pair( target, name ) );
      }
       
      prev_key = key_ptr;
    }
  
    //update attribute, if asked to do so
    if( update_attribs  )
    {
      CubitAttrib *attrib = target->get_cubit_attrib( CA_ENTITY_NAME );
      attrib->has_updated( CUBIT_FALSE );
      attrib->update();
    }
    
  }
  else
  {
    //If we don't care about unique base names, just add them all.
    DLIList<CubitString> name_list;
    for( int i = source_list.size(); i > 0; i-- )
      get_refentity_name( source_list.get_and_step(), name_list );
    name_list.reset();
    add_refentity_name(target, name_list, update_attribs, false);
  }
}



void RefEntityName::set_suffix_setting(CubitString rep)
{
  const char* tmp = rep.c_str();
  suffixCharacter = tmp[0];
}

CubitString RefEntityName::get_suffix_setting()
{
  char tmp[] = {suffixCharacter, '\0'};
  return CubitString(tmp);
}

void RefEntityName::set_replacement_setting(CubitString rep)
{
  const char* tmp = rep.c_str();
  replacementCharacter = tmp[0];
}

CubitString RefEntityName::get_replacement_setting()
{
  char tmp[] = {replacementCharacter, '\0'};
  return CubitString(tmp);
}